openapi: 3.2.0 info: description: 'Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the [Networking](/iaas/Content/Network/Concepts/overview.htm), [Compute](/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](/iaas/Content/Block/Concepts/overview.htm) services. The required permissions are documented in the [Details for the Core Services](/iaas/Content/Identity/Reference/corepolicyreference.htm) article. ' license: name: Oracle Corporation title: Core Services Virtual Network API version: '20160918' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/8839cf1f6cfca996dd92bc573c2a7c14db20e7f5d6e244c7d62365fa9d770623.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Core Services API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/8839cf1f6cfca996dd92bc573c2a7c14db20e7f5d6e244c7d62365fa9d770623.yaml what: the harvested document for Core Services API servers: - url: /20160918 tags: - name: virtualNetwork paths: /allowedPeerRegionsForRemotePeering: get: description: 'Lists the regions that support remote VCN peering (which is peering across regions). For more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). ' operationId: ListAllowedPeerRegionsForRemotePeering responses: 200: description: The list is retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/PeerRegionForRemotePeering' type: array 401: $ref: '#/components/responses/401' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListAllowedPeerRegionsForRemotePeering tags: - virtualNetwork x-obmcs-client-retries-enabled: true /byoasns: get: description: 'Lists the `Byoasn` resources in the specified compartment. You can filter the list using query parameters. ' operationId: ListByoasns parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/ByoasnSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ByoasnCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListByoasns tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Byoasn' post: description: 'Creates a BYOASN Resource ' operationId: CreateByoasn parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The BYOASN resource was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Byoasn' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateByoasn tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateByoasnDetails' description: Details needed to create a BYOASN Resource. required: true /byoasns/{byoasnId}: delete: description: 'Deletes the specified `Byoasn` resource. The resource must be in one of the following states: CREATING, ACTIVE or FAILED. It must not be in use by any of the byoipRanges or deletion will fail. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: DeleteByoasn parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoasnIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The `Byoasn` resource is deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteByoasn tags: - virtualNetwork x-related-resource: '#/definitions/Byoasn' get: description: 'Gets the `Byoasn` resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetByoasn parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoasnIdPathParam' responses: 200: description: The `Byoasn` resource was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Byoasn' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetByoasn tags: - virtualNetwork x-obmcs-client-retries-enabled: true put: description: 'Updates the tags or display name associated with the specified BYOASN Resource. ' operationId: UpdateByoasn parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoasnIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The associated tags or display name for the BYOASN resource were updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Byoasn' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateByoasn tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateByoasnDetails' description: Byoasn Range details. required: true /byoasns/{byoasnId}/actions/changeCompartment: post: description: 'Moves a BYOASN Resource to a different compartment. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeByoasnCompartment parameters: - $ref: '#/components/parameters/ByoasnIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The asn resource was moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeByoasnCompartment tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Byoasn' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeByoasnCompartmentDetails' description: Request to change the compartment of a BYOIP CIDR block. required: true /byoasns/{byoasnId}/actions/validate: post: description: 'Submits the BYOASN for validation. Please do not submit to Oracle for validation if the information for the BYOASN is not already modified in the Regional Internet Registry. See [To import a BYOASN](/iaas/Content/Network/Concepts/BYOASN.htm) for details. ' operationId: ValidateByoasn parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoasnIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The Byoasn submitted for validation. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ValidateByoasn tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/Byoasn' /byoipRanges: get: description: 'Lists the `ByoipRange` resources in the specified compartment. You can filter the list using query parameters. ' operationId: ListByoipRanges parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByLifecycleStateQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ByoipRangeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListByoipRanges tags: - virtualNetwork x-related-resource: '#/definitions/ByoipRange' post: description: 'Creates a subrange of the BYOIP CIDR block. ' operationId: CreateByoipRange parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The BYOIP CIDR block was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ByoipRange' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateByoipRange tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateByoipRangeDetails' description: Details needed to create a BYOIP CIDR block subrange. required: true /byoipRanges/{byoipRangeId}: delete: description: 'Deletes the specified `ByoipRange` resource. The resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED. It must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). If the `ByoipRange` resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted. ' operationId: DeleteByoipRange parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoipRangeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The `ByoipRange` resource is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteByoipRange tags: - virtualNetwork x-related-resource: '#/definitions/ByoipRange' get: description: 'Gets the `ByoipRange` resource. You must specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetByoipRange parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoipRangeIdPathParam' responses: 200: description: The `ByoipRange` resource was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ByoipRange' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetByoipRange tags: - virtualNetwork put: description: 'Updates the tags or display name associated to the specified BYOIP CIDR block. ' operationId: UpdateByoipRange parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoipRangeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The associated tags or display name for a BYOIP CIDR block were updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ByoipRange' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateByoipRange tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateByoipRangeDetails' description: Byoip Range details. required: true /byoipRanges/{byoipRangeId}/actions/advertise: post: description: 'Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud. The `ByoipRange` resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP. ' operationId: AdvertiseByoipRange parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoipRangeIdPathParam' responses: 204: description: The BYOIP CIDR block is being advertised. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AdvertiseByoipRange tags: - virtualNetwork x-related-resource: '#/definitions/ByoipRange' /byoipRanges/{byoipRangeId}/actions/changeCompartment: post: description: 'Moves a BYOIP CIDR block to a different compartment. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeByoipRangeCompartment parameters: - $ref: '#/components/parameters/ByoipRangeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The BYOIP CIDR block was moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeByoipRangeCompartment tags: - virtualNetwork x-related-resource: '#/definitions/ByoipRange' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeByoipRangeCompartmentDetails' description: Request to change the compartment of a BYOIP CIDR block. required: true /byoipRanges/{byoipRangeId}/actions/setOrigin/byoasn: post: description: 'Update BYOIP''s origin ASN to byoasn. ' operationId: SetOriginAsn parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoipRangeIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Recieved update prefix's origin request. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: SetOriginAsn tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/ByoipRange' requestBody: content: application/json: schema: $ref: '#/components/schemas/SetOriginAsnDetails' description: ASN details required: true /byoipRanges/{byoipRangeId}/actions/setOrigin/oracleAsn: post: description: 'Update prefix''s origin ASN to OCI ' operationId: SetOriginAsnToOracle parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoipRangeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: Origin ASN was updated with Oracle ASN. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: SetOriginAsnToOracle tags: - virtualNetwork x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/ByoipRange' /byoipRanges/{byoipRangeId}/actions/validate: post: description: 'Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already modified the information for the BYOIP CIDR block with your Regional Internet Registry. See [To import a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details. ' operationId: ValidateByoipRange parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoipRangeIdPathParam' responses: 202: description: The BYOIP CIDR was submitted for validation. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ValidateByoipRange tags: - virtualNetwork x-related-resource: '#/definitions/ByoipRange' /byoipRanges/{byoipRangeId}/actions/withdraw: post: description: 'Withdraws BGP route advertisement for the BYOIP CIDR block. ' operationId: WithdrawByoipRange parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoipRangeIdPathParam' responses: 204: description: The BYOIP CIDR block was withdrawn from BGP advertisement. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: WithdrawByoipRange tags: - virtualNetwork x-related-resource: '#/definitions/ByoipRange' /byoipRanges/{byoipRangeId}/byoipAllocatedRanges: get: description: 'Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool. Each `ByoipAllocatedRange` object also lists the IP pool where it is allocated. ' operationId: ListByoipAllocatedRanges parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ByoipRangeIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ByoipAllocatedRangeCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListByoipAllocatedRanges tags: - virtualNetwork x-related-resource: '#/definitions/ByoipAllocatedRangeSummary' /captureFilters: get: description: 'Lists the capture filters in the specified compartment. ' operationId: ListCaptureFilters parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByCaptureFilterLifecycleStateQueryParam' responses: 200: description: The list of VTAP filters is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/CaptureFilter' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCaptureFilters tags: - virtualNetwork post: description: 'Creates a virtual test access point (VTAP) capture filter in the specified compartment. For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it. ' operationId: CreateCaptureFilter parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The capture filter was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CaptureFilter' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateCaptureFilter tags: - virtualNetwork x-example: "POST /20160918/captureFilters\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"MyCaptureFilter\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCaptureFilterDetails' description: Details for creating a capture filter. required: true /captureFilters/{captureFilterId}: delete: description: 'Deletes the specified VTAP capture filter. This is an asynchronous operation. The VTAP capture filter''s `lifecycleState` will change to TERMINATING temporarily until the VTAP capture filter is completely removed. ' operationId: DeleteCaptureFilter parameters: - $ref: '#/components/parameters/CaptureFilterIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The capture filter is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteCaptureFilter tags: - virtualNetwork x-related-resource: '#/definitions/CaptureFilter' get: description: Gets information about the specified VTAP capture filter. operationId: GetCaptureFilter parameters: - $ref: '#/components/parameters/CaptureFilterIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The VTAP capture filter was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CaptureFilter' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCaptureFilter tags: - virtualNetwork put: description: 'Updates the specified VTAP capture filter''s display name or tags. ' operationId: UpdateCaptureFilter parameters: - $ref: '#/components/parameters/CaptureFilterIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The VTAP capture filter was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CaptureFilter' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateCaptureFilter tags: - virtualNetwork x-related-resource: '#/definitions/CaptureFilter' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCaptureFilterDetails' description: Details object for updating a VTAP. required: true /captureFilters/{captureFilterId}/actions/changeCompartment: post: description: 'Moves a capture filter to a new compartment in the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeCaptureFilterCompartment parameters: - $ref: '#/components/parameters/CaptureFilterIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The capture filter is being moved to the new compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeCaptureFilterCompartment tags: - virtualNetwork x-related-resource: '#/definitions/CaptureFilter' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCaptureFilterCompartmentDetails' description: Request to change the compartment of a VTAP. required: true /cpeDeviceShapes: get: description: "Lists the CPE device types that the Networking service provides CPE configuration\ncontent for (example: Cisco ASA). The content helps a network engineer configure\nthe actual CPE device represented by a [Cpe](#/en/iaas/latest/Cpe/) object.\n\nIf you want to generate CPE configuration content for one of the returned CPE device types,\nensure that the [Cpe](#/en/iaas/latest/Cpe/) object's `cpeDeviceShapeId` attribute is set\nto the CPE device type's [OCID](/iaas/Content/General/Concepts/identifiers.htm) (returned by this operation).\n\nFor information about generating CPE configuration content, see these operations:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n" operationId: ListCpeDeviceShapes parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/CpeDeviceShapeSummary' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCpeDeviceShapes tags: - virtualNetwork x-obmcs-client-retries-enabled: true /cpeDeviceShapes/{cpeDeviceShapeId}: get: description: "Gets the detailed information about the specified CPE device type. This might include a set of questions\nthat are specific to the particular CPE device type. The customer must supply answers to those questions\n(see [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)).\nThe service merges the answers with a template of other information for the CPE device type. The following\noperations return the merged content:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n" operationId: GetCpeDeviceShape parameters: - $ref: '#/components/parameters/CpeDeviceShapeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The parameters is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CpeDeviceShapeDetail' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCpeDeviceShape tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CpeDeviceShapeDetail' /cpes: get: description: 'Lists the customer-premises equipment objects (CPEs) in the specified compartment. ' operationId: ListCpes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Cpe' type: array 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCpes tags: - virtualNetwork x-obmcs-client-retries-enabled: true post: description: 'Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For more information, see [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the CPE to reside. Notice that the CPE doesn''t have to be in the same compartment as the IPSec connection or other Networking Service components. If you''re not sure which compartment to use, put the CPE in the same compartment as the DRG. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You must provide the public IP address of your on-premises router. See [CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm). You may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. ' operationId: CreateCpe parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The CPE has been created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Cpe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateCpe tags: - virtualNetwork x-example: "POST /20160918/cpes\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"ipAddress\" : \"203.0.113.6\",\n \"displayName\" : \"MyCpe\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<compartment_OCID>\"\n}\n" x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCpeDetails' description: Details for creating a CPE. required: true /cpes/{cpeId}: delete: description: 'Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous operation. The CPE''s `lifecycleState` will change to TERMINATING temporarily until the CPE is completely removed. ' operationId: DeleteCpe parameters: - $ref: '#/components/parameters/CpeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The CPE is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteCpe tags: - virtualNetwork x-obmcs-client-retries-enabled: true get: description: Gets the specified CPE's information. operationId: GetCpe parameters: - $ref: '#/components/parameters/CpeIdPathParam' responses: 200: description: The CPE was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Cpe' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCpe tags: - virtualNetwork x-obmcs-client-retries-enabled: true put: description: 'Updates the specified CPE''s display name or tags. Avoid entering confidential information. ' operationId: UpdateCpe parameters: - $ref: '#/components/parameters/CpeIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The CPE was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Cpe' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateCpe tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCpeDetails' description: Details object for updating a CPE. required: true /cpes/{cpeId}/actions/changeCompartment: post: description: 'Moves a CPE object into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeCpeCompartment parameters: - $ref: '#/components/parameters/CpeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The CPE object has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeCpeCompartment tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Cpe' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCpeCompartmentDetails' description: Request to change the compartment of a CPE. required: true /cpes/{cpeId}/cpeConfigContent: get: description: "Renders a set of CPE configuration content that can help a network engineer configure the actual\nCPE device (for example, a hardware router) represented by the specified [Cpe](#/en/iaas/latest/Cpe/)\nobject.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) must have the CPE's device type specified by the `cpeDeviceShapeId`\nattribute. The content optionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for *all* of the\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/) objects that use the specified CPE.\nHere are similar operations:\n\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n returns CPE configuration content for all IPSec tunnels in a single IPSec connection.\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n returns CPE configuration content for a specific IPSec tunnel in an IPSec connection.\n" operationId: GetCpeDeviceConfigContent parameters: - $ref: '#/components/parameters/CpeIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The information was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: text/plain; charset=utf-8: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCpeDeviceConfigContent tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Cpe' /crossConnectGroups: get: description: 'Lists the cross-connect groups in the specified compartment. ' operationId: ListCrossConnectGroups parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to return only resources that match the specified lifecycle state. The value is case insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/CrossConnectGroup/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/CrossConnectGroup' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCrossConnectGroups tags: - virtualNetwork x-obmcs-client-retries-enabled: true post: description: 'Creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the cross-connect group to reside. If you''re not sure which compartment to use, put the cross-connect group in the same compartment with your VCN. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the cross-connect group. It does not have to be unique, and you can change it. Avoid entering confidential information. ' operationId: CreateCrossConnectGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The cross-connect group was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CrossConnectGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateCrossConnectGroup tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCrossConnectGroupDetails' description: Details to create a CrossConnectGroup required: true /crossConnectGroups/{crossConnectGroupId}: delete: description: 'Deletes the specified cross-connect group. It must not contain any cross-connects, and it cannot be mapped to a [VirtualCircuit](#/en/iaas/latest/VirtualCircuit/). ' operationId: DeleteCrossConnectGroup parameters: - $ref: '#/components/parameters/CrossConnectGroupIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The cross-connect group is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteCrossConnectGroup tags: - virtualNetwork x-obmcs-client-retries-enabled: true get: description: Gets the specified cross-connect group's information. operationId: GetCrossConnectGroup parameters: - $ref: '#/components/parameters/CrossConnectGroupIdPathParam' responses: 200: description: The cross-connect group was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CrossConnectGroup' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCrossConnectGroups tags: - virtualNetwork x-obmcs-client-retries-enabled: true put: description: 'Updates the specified cross-connect group''s display name. Avoid entering confidential information. ' operationId: UpdateCrossConnectGroup parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/CrossConnectGroupIdPathParam' responses: 200: description: The cross-connect group was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CrossConnectGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateCrossConnectGroup tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCrossConnectGroupDetails' description: Update CrossConnectGroup fields required: true /crossConnectGroups/{crossConnectGroupId}/actions/changeCompartment: post: description: 'Moves a cross-connect group into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeCrossConnectGroupCompartment parameters: - $ref: '#/components/parameters/CrossConnectGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The cross-connect group has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeCrossConnectGroupCompartment tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CrossConnectGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCrossConnectGroupCompartmentDetails' description: Request to change the compartment of a Cross Connect Group. required: true /crossConnectLocations: get: description: 'Lists the available FastConnect locations for cross-connect installation. You need this information so you can specify your desired location when you create a cross-connect. ' operationId: ListCrossConnectLocations parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/CrossConnectLocation' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCrossConnectLocations tags: - virtualNetwork x-obmcs-client-retries-enabled: true /crossConnectPortSpeedShapes: get: description: 'Lists the available port speeds for cross-connects. You need this information so you can specify your desired port speed (that is, shape) when you create a cross-connect. ' operationId: ListCrossconnectPortSpeedShapes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/CrossConnectPortSpeedShape' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCrossConnectPortSpeedShapes tags: - virtualNetwork x-obmcs-client-retries-enabled: true /crossConnects: get: description: 'Lists the cross-connects in the specified compartment. You can filter the list by specifying the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a cross-connect group. ' operationId: ListCrossConnects parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/CrossConnectGroupIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to return only resources that match the specified lifecycle state. The value is case insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/CrossConnect/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/CrossConnect' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCrossConnects tags: - virtualNetwork x-obmcs-client-retries-enabled: true post: description: 'Creates a new cross-connect. Oracle recommends you create each cross-connect in a [CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation with the connection. After creating the `CrossConnect` object, you need to go the FastConnect location and request to have the physical cable installed. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the cross-connect to reside. If you''re not sure which compartment to use, put the cross-connect in the same compartment with your VCN. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the cross-connect. It does not have to be unique, and you can change it. Avoid entering confidential information. ' operationId: CreateCrossConnect parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The cross-connect was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CrossConnect' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateCrossConnect tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateCrossConnectDetails' description: Details to create a CrossConnect required: true /crossConnects/{crossConnectId}: delete: description: 'Deletes the specified cross-connect. It must not be mapped to a [VirtualCircuit](#/en/iaas/latest/VirtualCircuit/). ' operationId: DeleteCrossConnect parameters: - $ref: '#/components/parameters/CrossConnectIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The cross-connect is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteCrossConnect tags: - virtualNetwork x-obmcs-client-retries-enabled: true get: description: Gets the specified cross-connect's information. operationId: GetCrossConnect parameters: - $ref: '#/components/parameters/CrossConnectIdPathParam' responses: 200: description: The cross-connect was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CrossConnect' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCrossConnect tags: - virtualNetwork x-obmcs-client-retries-enabled: true put: description: Updates the specified cross-connect. operationId: UpdateCrossConnect parameters: - $ref: '#/components/parameters/CrossConnectIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The cross-connect was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CrossConnect' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateCrossConnect tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCrossConnectDetails' description: Update CrossConnect fields. required: true /crossConnects/{crossConnectId}/actions/changeCompartment: post: description: 'Moves a cross-connect into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeCrossConnectCompartment parameters: - $ref: '#/components/parameters/CrossConnectIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The cross-connect has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeCrossConnectCompartment tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/CrossConnect' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeCrossConnectCompartmentDetails' description: Request to change the compartment of a Cross Connect. required: true /crossConnects/{crossConnectId}/letterOfAuthority: get: description: Gets the Letter of Authority for the specified cross-connect. operationId: GetCrossConnectLetterOfAuthority parameters: - $ref: '#/components/parameters/CrossConnectIdPathParam' responses: 200: description: The Letter of Authority was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LetterOfAuthority' text/html: schema: $ref: '#/components/schemas/LetterOfAuthority' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Gets the Letter of Authority associated with the mentioned cross-connect. tags: - virtualNetwork x-obmcs-client-retries-enabled: true /crossConnects/{crossConnectId}/status: get: description: 'Gets the status of the specified cross-connect. ' operationId: GetCrossConnectStatus parameters: - $ref: '#/components/parameters/CrossConnectIdPathParam' responses: 200: description: The cross-connect's status was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CrossConnectStatus' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetCrossConnectStatus tags: - virtualNetwork x-obmcs-client-retries-enabled: true /dhcps: get: description: 'Lists the sets of DHCP options in the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment. The response includes the default set of options that automatically comes with each VCN, plus any other sets you''ve created. ' operationId: ListDhcpOptions parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DhcpOptions/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DhcpOptions' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDhcpOptions tags: - virtualNetwork post: description: 'Creates a new set of DHCP options for the specified VCN. For more information, see [DhcpOptions](#/en/iaas/latest/DhcpOptions/). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the set of DHCP options to reside. Notice that the set of options doesn''t have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you''re not sure which compartment to use, put the set of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the set of DHCP options, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. ' operationId: CreateDhcpOptions parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The set of DHCP options has been created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DhcpOptions' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateDhcpOptions tags: - virtualNetwork x-example: "POST /20160918/dhcps\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"options\" : [{\n \"type\" : \"DomainNameServer\",\n \"customDnsServers\" : [\"203.0.113.6\"],\n \"serverType\" : \"CustomDnsServer\"\n }],\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\",\n \"displayName\" : \"MyDhcpOptions\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDhcpDetails' description: Request object for creating a new set of DHCP options. required: true /dhcps/{dhcpId}: delete: description: 'Deletes the specified set of DHCP options, but only if it''s not associated with a subnet. You can''t delete a VCN''s default set of DHCP options. This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily until the set is completely removed. ' operationId: DeleteDhcpOptions parameters: - $ref: '#/components/parameters/DhcpIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The set of DHCP options is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteDhcpOptions tags: - virtualNetwork get: description: Gets the specified set of DHCP options. operationId: GetDhcpOptions parameters: - $ref: '#/components/parameters/DhcpIdPathParam' responses: 200: description: The set of DHCP options was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DhcpOptions' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDhcpOptions tags: - virtualNetwork put: description: 'Updates the specified set of DHCP options. You can update the display name or the options themselves. Avoid entering confidential information. Note that the `options` object you provide replaces the entire existing set of options. ' operationId: UpdateDhcpOptions parameters: - $ref: '#/components/parameters/DhcpIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The set of DHCP options was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DhcpOptions' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDhcpOptions tags: - virtualNetwork x-related-resource: '#/definitions/DhcpOptions' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDhcpDetails' description: Request object for updating a set of DHCP options. required: true /dhcps/{dhcpId}/actions/changeCompartment: post: description: 'Moves a set of DHCP options into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeDhcpOptionsCompartment parameters: - $ref: '#/components/parameters/DhcpIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The set of DHCP options has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeDhcpOptionsCompartment tags: - virtualNetwork x-related-resource: '#/definitions/DhcpOptions' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeDhcpOptionsCompartmentDetails' description: Request to change the compartment of a set of DHCP Options. required: true /drgAttachments: x-obmcs-client-retries-enabled: true get: description: 'Lists the `DrgAttachment` resource for the specified compartment. You can filter the results by DRG, attached network, attachment type, DRG route table or VCN route table. The LIST API lists DRG attachments by attachment type. It will default to list VCN attachments, but you may request to list ALL attachments of ALL types. ' operationId: ListDrgAttachments parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/DrgIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/NetworkIdQueryParam' - $ref: '#/components/parameters/DrgAttachmentTypeQueryParam' - $ref: '#/components/parameters/DrgRouteTableIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to return only resources that match the specified lifecycle state. The value is case insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DrgAttachment/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgAttachment' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDrgAttachments tags: - virtualNetwork post: description: 'Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG at a time, but a DRG can be attached to more than one VCN. The response includes a `DrgAttachment` object with its own [OCID](/iaas/Content/General/Concepts/identifiers.htm). For more information about DRGs, see [Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm). You may optionally specify a *display name* for the attachment, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. For the purposes of access control, the DRG attachment is automatically placed into the currently selected compartment. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). ' operationId: CreateDrgAttachment parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The DRG was attached. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateDrgAttachment tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDrgAttachmentDetails' description: Details for creating a `DrgAttachment`. required: true /drgAttachments/{drgAttachmentId}: x-obmcs-client-retries-enabled: true delete: description: 'Detaches a DRG from a network resource by deleting the corresponding `DrgAttachment` resource. This is an asynchronous operation. The attachment''s `lifecycleState` will temporarily change to DETACHING until the attachment is completely removed. ' operationId: DeleteDrgAttachment parameters: - $ref: '#/components/parameters/DrgAttachmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The DRG is being detached. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteDrgAttachment tags: - virtualNetwork get: description: Gets the `DrgAttachment` resource. operationId: GetDrgAttachment parameters: - $ref: '#/components/parameters/DrgAttachmentIdPathParam' responses: 200: description: The `DrgAttachment` was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgAttachment' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDrgAttachment tags: - virtualNetwork put: description: 'Updates the display name and routing information for the specified `DrgAttachment`. Avoid entering confidential information. ' operationId: UpdateDrgAttachment parameters: - $ref: '#/components/parameters/DrgAttachmentIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The `DrgAttachment` was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgAttachment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDrgAttachment tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDrgAttachmentDetails' description: Details object for updating a `DrgAttachment`. required: true /drgAttachments/{drgAttachmentId}/actions/removeExportDrgRouteDistribution: x-obmcs-client-retries-enabled: true post: description: 'Removes the export route distribution from the DRG attachment so no routes are advertised to it. ' operationId: RemoveExportDrgRouteDistribution parameters: - $ref: '#/components/parameters/DrgAttachmentIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The route distribution was removed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgAttachment' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoveExportDrgRouteDistribution tags: - virtualNetwork x-related-resource: '#/definitions/DrgAttachment' /drgRouteDistributions: x-obmcs-client-retries-enabled: true get: description: 'Lists the route distributions in the specified DRG. To retrieve the statements in a distribution, use the ListDrgRouteDistributionStatements operation. ' operationId: ListDrgRouteDistributions parameters: - $ref: '#/components/parameters/DrgIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter that only returns resources that match the specified lifecycle state. The value is case insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DrgRouteDistribution/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgRouteDistribution' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDrgRouteDistributionStatements tags: - virtualNetwork post: description: 'Creates a new route distribution for the specified DRG. Assign the route distribution as an import distribution to a DRG route table using the `UpdateDrgRouteTable` or `CreateDrgRouteTable` operations. Assign the route distribution as an export distribution to a DRG attachment using the `UpdateDrgAttachment` or `CreateDrgAttachment` operations. ' operationId: CreateDrgRouteDistribution parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The route distribution was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgRouteDistribution' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateDrgRouteDistribution tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDrgRouteDistributionDetails' description: Details for creating a route distribution. required: true /drgRouteDistributions/{drgRouteDistributionId}: x-obmcs-client-retries-enabled: true delete: description: 'Deletes the specified route distribution. You can''t delete a route distribution currently in use by a DRG attachment or DRG route table. Remove the DRG route distribution from a DRG attachment or DRG route table by using the "RemoveExportDrgRouteDistribution" or "RemoveImportDrgRouteDistribution'' operations. ' operationId: DeleteDrgRouteDistribution parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' responses: 204: description: The route distribution is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteDrgRouteDistribution tags: - virtualNetwork x-related-resource: '#/definitions/DrgRouteDistributionStatement' get: description: Gets the specified route distribution's information. operationId: GetDrgRouteDistribution parameters: - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' responses: 200: description: The route distribution was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgRouteDistribution' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDrgRouteDistribution tags: - virtualNetwork put: description: 'Updates the specified route distribution ' operationId: UpdateDrgRouteDistribution parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' responses: 200: description: The route distribution was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgRouteDistribution' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDrgRouteDistribution tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDrgRouteDistributionDetails' description: Details object for updating a route distribution required: true /drgRouteDistributions/{drgRouteDistributionId}/actions/addDrgRouteDistributionStatements: x-obmcs-client-retries-enabled: true post: description: 'Adds one or more route distribution statements to the specified route distribution. ' operationId: AddDrgRouteDistributionStatements parameters: - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' responses: 200: description: The route distribution statements were added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgRouteDistributionStatement' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AddDrgRouteDistributionStatements tags: - virtualNetwork x-related-resource: '#/definitions/DrgRouteDistributionStatement' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddDrgRouteDistributionStatementsDetails' description: Request with one or more route distribution statements to be inserted into the route distribution. required: true /drgRouteDistributions/{drgRouteDistributionId}/actions/removeDrgRouteDistributionStatements: x-obmcs-client-retries-enabled: true post: description: 'Removes one or more route distribution statements from the specified route distribution''s map. ' operationId: RemoveDrgRouteDistributionStatements parameters: - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' responses: 200: description: The route distribution statements are being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoveDrgRouteDistributionStatements tags: - virtualNetwork x-related-resource: '#/definitions/DrgRouteDistributionStatement' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveDrgRouteDistributionStatementsDetails' description: 'Request with one or more route distribution statements to remove from the route distribution. ' required: true /drgRouteDistributions/{drgRouteDistributionId}/actions/updateDrgRouteDistributionStatements: x-obmcs-client-retries-enabled: true post: description: 'Updates one or more route distribution statements in the specified route distribution. ' operationId: UpdateDrgRouteDistributionStatements parameters: - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' responses: 200: description: The route distribution statements were updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgRouteDistributionStatement' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDrgRouteDistributionStatements tags: - virtualNetwork x-related-resource: '#/definitions/DrgRouteDistributionStatement' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDrgRouteDistributionStatementsDetails' description: 'Request to update one or more route distribution statements in the route distribution. ' required: true /drgRouteDistributions/{drgRouteDistributionId}/drgRouteDistributionStatements: x-obmcs-client-retries-enabled: true get: description: Lists the statements for the specified route distribution. operationId: ListDrgRouteDistributionStatements parameters: - $ref: '#/components/parameters/DrgRouteDistributionIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ListDrgRouteDistributionStatementsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgRouteDistributionStatement' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDrgRouteDistributionStatements tags: - virtualNetwork /drgRouteTables: x-obmcs-client-retries-enabled: true get: description: 'Lists the DRG route tables for the specified DRG. Use the `ListDrgRouteRules` operation to retrieve the route rules in a table. ' operationId: ListDrgRouteTables parameters: - $ref: '#/components/parameters/DrgIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/ImportDrgRouteDistributionIdQueryParam' - description: 'A filter that only returns matches for the specified lifecycle state. The value is case insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/DrgRouteTable/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgRouteTable' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDrgRouteTables tags: - virtualNetwork post: description: 'Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment using the `UpdateDrgAttachment` or `CreateDrgAttachment` operations. ' operationId: CreateDrgRouteTable parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The DRG route table was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgRouteTable' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateDrgRouteTable tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDrgRouteTableDetails' description: Details for creating a DRG route table. required: true /drgRouteTables/{drgRouteTableId}: x-obmcs-client-retries-enabled: true delete: description: 'Deletes the specified DRG route table. There must not be any DRG attachments assigned. ' operationId: DeleteDrgRouteTable parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DrgRouteTableIdPathParam' responses: 204: description: The DRG route table is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteDrgRouteTable tags: - virtualNetwork x-related-resource: '#/definitions/InternalPublicIp' get: description: Gets the specified DRG route table's information. operationId: GetDrgRouteTable parameters: - $ref: '#/components/parameters/DrgRouteTableIdPathParam' responses: 200: description: The DRG route table was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgRouteTable' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDrgRouteTable tags: - virtualNetwork put: description: 'Updates the specified DRG route table. ' operationId: UpdateDrgRouteTable parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/DrgRouteTableIdPathParam' responses: 200: description: The DRG route table was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgRouteTable' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDrgRouteTable tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDrgRouteTableDetails' description: Details object used to updating a DRG route table. required: true /drgRouteTables/{drgRouteTableId}/actions/addDrgRouteRules: x-obmcs-client-retries-enabled: true post: description: 'Adds one or more static route rules to the specified DRG route table. ' operationId: AddDrgRouteRules parameters: - $ref: '#/components/parameters/DrgRouteTableIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The route rules were added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgRouteRule' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AddDrgRouteRules tags: - virtualNetwork x-related-resource: '#/definitions/DrgRouteRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddDrgRouteRulesDetails' description: Request for one or more route rules to be inserted into the DRG route table. required: true /drgRouteTables/{drgRouteTableId}/actions/removeDrgRouteRules: x-obmcs-client-retries-enabled: true post: description: 'Removes one or more route rules from the specified DRG route table. ' operationId: RemoveDrgRouteRules parameters: - $ref: '#/components/parameters/DrgRouteTableIdPathParam' responses: 200: description: The route rules are being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoveDrgRouteRules tags: - virtualNetwork x-related-resource: '#/definitions/DrgRouteRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveDrgRouteRulesDetails' description: 'Request to remove one or more route rules in the DRG route table. ' required: true /drgRouteTables/{drgRouteTableId}/actions/removeImportDrgRouteDistribution: x-obmcs-client-retries-enabled: true post: description: 'Removes the import route distribution from the DRG route table so no routes are imported into it. ' operationId: RemoveImportDrgRouteDistribution parameters: - $ref: '#/components/parameters/DrgRouteTableIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The route distribution was removed. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgRouteTable' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoveImportDrgRouteDistribution tags: - virtualNetwork x-related-resource: '#/definitions/DrgRouteTable' /drgRouteTables/{drgRouteTableId}/actions/updateDrgRouteRules: x-obmcs-client-retries-enabled: true post: description: 'Updates one or more route rules in the specified DRG route table. ' operationId: UpdateDrgRouteRules parameters: - $ref: '#/components/parameters/DrgRouteTableIdPathParam' responses: 200: description: The DRG route rules were updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgRouteRule' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDrgRouteRules tags: - virtualNetwork x-related-resource: '#/definitions/DrgRouteRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDrgRouteRulesDetails' description: 'Request to update one or more route rules in the DRG route table. ' required: true /drgRouteTables/{drgRouteTableId}/drgRouteRules: x-obmcs-client-retries-enabled: true get: description: Lists the route rules in the specified DRG route table. operationId: ListDrgRouteRules parameters: - $ref: '#/components/parameters/DrgRouteTableIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RouteTypeQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgRouteRule' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDrgRouteRules tags: - virtualNetwork /drgs: x-obmcs-client-retries-enabled: true get: description: 'Lists the DRGs in the specified compartment. ' operationId: ListDrgs parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Drg' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListDrgs tags: - virtualNetwork post: description: 'Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information, see [Dynamic Routing Gateways (DRGs)](/iaas/Content/Network/Tasks/managingDRGs.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the DRG to reside. Notice that the DRG doesn''t have to be in the same compartment as the VCN, the DRG attachment, or other Networking Service components. If you''re not sure which compartment to use, put the DRG in the same compartment as the VCN. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the DRG, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. ' operationId: CreateDrg parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The DRG was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Drg' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateDrg tags: - virtualNetwork x-example: "POST /20160918/drgs\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"MyDrg\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateDrgDetails' description: Details for creating a DRG. required: true /drgs/{drgId}: x-obmcs-client-retries-enabled: true delete: description: 'Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise network. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous operation. The DRG''s `lifecycleState` will change to TERMINATING temporarily until the DRG is completely removed. ' operationId: DeleteDrg parameters: - $ref: '#/components/parameters/DrgIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The DRG is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteDrg tags: - virtualNetwork get: description: Gets the specified DRG's information. operationId: GetDrg parameters: - $ref: '#/components/parameters/DrgIdPathParam' responses: 200: description: The DRG was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Drg' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDrg tags: - virtualNetwork put: description: 'Updates the specified DRG''s display name or tags. Avoid entering confidential information. ' operationId: UpdateDrg parameters: - $ref: '#/components/parameters/DrgIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The DRG was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Drg' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateDrg tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDrgDetails' description: Details object for updating a DRG. required: true /drgs/{drgId}/actions/getAllDrgAttachments: x-obmcs-client-retries-enabled: true post: description: 'Returns a complete list of DRG attachments that belong to a particular DRG. ' operationId: GetAllDrgAttachments parameters: - $ref: '#/components/parameters/DrgIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/DrgAttachmentTypeQueryParam' - $ref: '#/components/parameters/CrossTenancyQueryParam' responses: 202: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/DrgAttachmentInfo' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAllDrgAttachments tags: - virtualNetwork x-related-resource: '#/definitions/Drg' /drgs/{drgId}/actions/upgrade: x-obmcs-client-retries-enabled: true post: description: 'Upgrades the DRG. After upgrade, you can control routing inside your DRG via DRG attachments, route distributions, and DRG route tables. ' operationId: UpgradeDrg parameters: - $ref: '#/components/parameters/DrgIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The DRG is upgrading. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpgradeDrg tags: - virtualNetwork x-related-resource: '#/definitions/Drg' /drgs/{drgId}/actions/upgradeStatus: x-obmcs-client-retries-enabled: true get: description: 'Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed. ' operationId: GetUpgradeStatus parameters: - $ref: '#/components/parameters/DrgIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The DRG is upgrading. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpgradeStatus' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpgradeStatus tags: - virtualNetwork x-related-resource: '#/definitions/Drg' /drgs/{drgId}/redundancyStatus: get: description: 'Gets the redundancy status for the specified DRG. For more information, see [Redundancy Remedies](/iaas/Content/Network/Troubleshoot/drgredundancy.htm). ' operationId: GetDrgRedundancyStatus parameters: - $ref: '#/components/parameters/DrgIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The parameters is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DrgRedundancyStatus' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetDrgRedundancyStatus tags: - virtualNetwork x-obmcs-client-retries-enabled: true /fastConnectProviderServices: get: description: 'Lists the service offerings from supported providers. You need this information so you can specify your desired provider and service offering when you create a virtual circuit. For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment). For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). ' operationId: ListFastConnectProviderServices parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/FastConnectProviderService' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListFastConnectProviderServices tags: - virtualNetwork x-obmcs-client-retries-enabled: true /fastConnectProviderServices/{providerServiceId}: get: description: 'Gets the specified provider service. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). ' operationId: GetFastConnectProviderService parameters: - $ref: '#/components/parameters/ProviderServiceIdPathParam' responses: 200: description: The provider service is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/FastConnectProviderService' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetFastConnectProviderService tags: - virtualNetwork x-obmcs-client-retries-enabled: true /fastConnectProviderServices/{providerServiceId}/providerServiceKeys/{providerServiceKeyName}: get: description: 'Gets the specified provider service key''s information. Use this operation to validate a provider service key. An invalid key returns a 404 error. ' operationId: GetFastConnectProviderServiceKey parameters: - $ref: '#/components/parameters/ProviderServiceIdPathParam' - $ref: '#/components/parameters/ProviderServiceKeyNamePathParam' responses: 200: description: The provider service key name is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/FastConnectProviderServiceKey' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetFastConnectProviderServiceKey tags: - virtualNetwork x-obmcs-client-retries-enabled: true /fastConnectProviderServices/{providerServiceId}/virtualCircuitBandwidthShapes: get: description: 'Gets the list of available virtual circuit bandwidth levels for a provider. You need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit. For more information about virtual circuits, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). ' operationId: ListFastConnectProviderVirtualCircuitBandwidthShapes parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ProviderServiceIdPathParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VirtualCircuitBandwidthShape' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListFastConnectProviderVirtualCircuitBandwidthShapes tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/FastConnectProviderService' /internetGateways: get: description: 'Lists the internet gateways in the specified VCN and the specified compartment. If the VCN ID is not provided, then the list includes the internet gateways from all VCNs in the specified compartment. ' operationId: ListInternetGateways parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/InternetGateway/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/InternetGateway' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListInternetGateways tags: - virtualNetwork post: description: 'Creates a new internet gateway for the specified VCN. For more information, see [Access to the Internet](/iaas/Content/Network/Tasks/managingIGs.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the Internet Gateway to reside. Notice that the internet gateway doesn''t have to be in the same compartment as the VCN or other Networking Service components. If you''re not sure which compartment to use, put the Internet Gateway in the same compartment with the VCN. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). You may optionally specify a *display name* for the internet gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. For traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in the subnet''s route table (for example, 0.0.0.0/0 > internet gateway). See [UpdateRouteTable](#/en/iaas/latest/RouteTable/UpdateRouteTable). You must specify whether the internet gateway is enabled when you create it. If it''s disabled, that means no traffic will flow to/from the internet even if there''s a route rule that enables that traffic. You can later use [UpdateInternetGateway](#/en/iaas/latest/InternetGateway/UpdateInternetGateway) to easily disable/enable the gateway without changing the route rule. ' operationId: CreateInternetGateway parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The internet gateway was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/InternetGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateInternetGateway tags: - virtualNetwork x-example: "POST /20160918/internetGateways\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"MyInternetGateway\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\",\n \"isEnabled\" : true\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateInternetGatewayDetails' description: Details for creating a new internet gateway. required: true /internetGateways/{igId}: delete: description: 'Deletes the specified internet gateway. The internet gateway does not have to be disabled, but there must not be a route table that lists it as a target. This is an asynchronous operation. The gateway''s `lifecycleState` will change to TERMINATING temporarily until the gateway is completely removed. ' operationId: DeleteInternetGateway parameters: - $ref: '#/components/parameters/InternetGatewayIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The internet gateway is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteInternetGateway tags: - virtualNetwork get: description: Gets the specified internet gateway's information. operationId: GetInternetGateway parameters: - $ref: '#/components/parameters/InternetGatewayIdPathParam' responses: 200: description: The internet gateway was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/InternetGateway' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetInternetGateway tags: - virtualNetwork put: description: 'Updates the specified internet gateway. You can disable/enable it, or change its display name or tags. Avoid entering confidential information. If the gateway is disabled, that means no traffic will flow to/from the internet even if there''s a route rule that enables that traffic. ' operationId: UpdateInternetGateway parameters: - $ref: '#/components/parameters/InternetGatewayIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The internet gateway was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/InternetGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateInternetGateway tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateInternetGatewayDetails' description: Details for updating the internet gateway. required: true /internetGateways/{igId}/actions/changeCompartment: post: description: 'Moves an internet gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeInternetGatewayCompartment parameters: - $ref: '#/components/parameters/InternetGatewayIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The internet gateway has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeInternetGatewayCompartment tags: - virtualNetwork x-related-resource: '#/definitions/InternetGateway' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeInternetGatewayCompartmentDetails' description: Request to change the compartment of an internet gateway. required: true /ipInventory: post: description: 'Lists the IP Inventory information in the selected compartments. ' operationId: ListIpInventory parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Lists details of IP Inventory data. headers: data-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the resource. ' schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string lifecycle-state: description: The IpInventory API current state. schema: type: string enum: - IN_PROGRESS - DONE opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For list pagination. A pagination token to get the total number of results available. ' schema: type: integer opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IpInventoryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListIpInventory tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/ListIpInventoryDetails' description: Details required to list the IP Inventory data. required: true /ipInventory/subnets/{subnetId}: get: description: 'Gets the IP Inventory data of the specified subnet. Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetSubnetIpInventory parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SubnetIdPathParam' responses: 200: description: Retrieve `IpInventorySubnetResourceCollection` resource. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IpInventorySubnetResourceCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetSubnetIpInventory tags: - virtualNetwork /ipInventory/subnets/{subnetId}/cidrs: get: description: 'Gets the CIDR utilization data of the specified subnet. Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetSubnetCidrUtilization parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SubnetIdPathParam' responses: 200: description: Retrieve `IpInventoryCidrUtilizationCollection` resource. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For list pagination. A pagination token to get the total number of results available. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/IpInventoryCidrUtilizationCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetSubnetCidrUtilization tags: - virtualNetwork /ipInventory/vcns/{vcnId}/overlaps: post: description: 'Gets the CIDR overlap information of the specified VCN in selected compartments. Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetVcnOverlap parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/VcnIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: Retrieve the VCN Overlap details. headers: data-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the resource. ' schema: type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string lifecycle-state: description: The IpInventory API current state. schema: type: string enum: - IN_PROGRESS - DONE opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For list pagination. A pagination token to get the total number of results available. ' schema: type: integer opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IpInventoryVcnOverlapCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetIpInventoryVcnOverlap tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/GetIpInventoryVcnOverlapDetails' description: Lists details of the IP Inventory VCN overlap data. required: true /ipinventory/DataRequestId/{dataRequestId}: get: description: 'Gets the `IpInventory` resource. ' operationId: GetResourceIpInventory parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/DataRequestIdPathParam' responses: 200: description: Lists the IP Inventory data. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For list pagination. A pagination token to get the total number of results available. ' schema: type: integer content: application/json: schema: $ref: '#/components/schemas/IpInventoryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetResourceIpInventory tags: - virtualNetwork /ipsecAlgorithms: get: description: 'The parameters allowed for IKE IPSec tunnels. ' operationId: GetAllowedIkeIPSecParameters parameters: - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The parameters allowed for IKE IPSec were retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AllowedIkeIPSecParameters' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetAllowedIkeIPSecParameters tags: - virtualNetwork x-obmcs-client-retries-enabled: true /ipsecConnections: get: description: 'Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE. ' operationId: ListIPSecConnections parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DrgIdOptionalQueryParam' - $ref: '#/components/parameters/CpeIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/IPSecConnection' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListIPSecConnections tags: - virtualNetwork x-obmcs-client-retries-enabled: true post: description: "Creates a new IPSec connection between the specified DRG and CPE. For more information, see\n[Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm).\n\nIf you configure at least one tunnel to use static routing, then in the request you must provide\nat least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16.\nIf you configure both tunnels to use BGP dynamic routing, you can provide an empty list for\nthe static routes. For more information, see the important note in\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/).\n\nFor the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the\nIPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment\nas the DRG, CPE, or other Networking Service components. If you're not sure which compartment to\nuse, put the IPSec connection in the same compartment as the DRG. For more information about\ncompartments and access control, see\n[Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm).\n\nYou may optionally specify a *display name* for the IPSec connection, otherwise a default is provided.\nIt does not have to be unique, and you can change it. Avoid entering confidential information.\n\nAfter creating the IPSec connection, you need to configure your on-premises router\nwith tunnel-specific information. For tunnel status and the required configuration information, see:\n\n * [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)\n * [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/)\n\nFor each tunnel, you need the IP address of Oracle's VPN headend and the shared secret\n(that is, the pre-shared key). For more information, see\n[CPE Configuration](/iaas/Content/Network/Tasks/configuringCPE.htm).\n" operationId: CreateIPSecConnection parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The IPSec connection was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateIPSecConnection tags: - virtualNetwork x-example: "POST /20160918/ipsecConnections\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"MyIPSecConnection\",\n \"cpeId\" : \"ocid1.cpe.oc1.phx.<unique_ID>\",\n \"staticRoutes\" : [\"192.0.2.0/24\", \"2001:db8::/32\" ],\n \"drgId\" : \"ocid1.drg.oc1.phx.<unique_ID>\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIPSecConnectionDetails' description: Details for creating an `IPSecConnection`. required: true /ipsecConnections/{ipscId}: delete: description: 'Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and on-premises network, it''s easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact. If you were to delete all the components and then later need to create an Site-to-Site VPN again, you would need to configure your on-premises router again with the new information returned from [CreateIPSecConnection](#/en/iaas/latest/IPSecConnection/CreateIPSecConnection). This is an asynchronous operation. The connection''s `lifecycleState` will change to TERMINATING temporarily until the connection is completely removed. ' operationId: DeleteIPSecConnection parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The request has been accepted headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteIPSecConnection tags: - virtualNetwork x-obmcs-client-retries-enabled: true get: description: 'Gets the specified IPSec connection''s basic information, including the static routes for the on-premises router. If you want the status of the connection (whether it''s up or down), use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel). ' operationId: GetIPSecConnection parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' responses: 200: description: The information was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnection' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetIPSecConnection tags: - virtualNetwork x-obmcs-client-retries-enabled: true put: description: 'Updates the specified IPSec connection. To update an individual IPSec tunnel''s attributes, use [UpdateIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/UpdateIPSecConnectionTunnel). ' operationId: UpdateIPSecConnection parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The IPSec connection was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateIPSecConnection tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIPSecConnectionDetails' description: Details object for updating an IPSec connection. required: true /ipsecConnections/{ipscId}/actions/changeCompartment: post: description: 'Moves an IPSec connection into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeIPSecConnectionCompartment parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The IPSec connection has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeIPSecConnectionCompartment tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/IPSecConnection' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeIPSecConnectionCompartmentDetails' description: Request to change the compartment of a IPSec connection. required: true /ipsecConnections/{ipscId}/cpeConfigContent: get: description: "Renders a set of CPE configuration content for the specified IPSec connection (for all the\ntunnels in the connection). The content helps a network engineer configure the actual CPE\ndevice (for example, a hardware router) that the specified IPSec connection terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content\noptionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for all tunnels in the single specified\n[IPSecConnection](#/en/iaas/latest/IPSecConnection/) object. Here are other similar\noperations:\n\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n returns CPE configuration content for a specific tunnel within an IPSec connection.\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n returns CPE configuration content for *all* IPSec connections that use a specific CPE.\n" operationId: GetIpsecCpeDeviceConfigContent parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The information was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: text/plain; charset=utf-8: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetIpsecCpeDeviceConfigContent tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/IPSecConnection' /ipsecConnections/{ipscId}/deviceConfig: get: description: 'Deprecated. To get tunnel information, instead use: * [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel) * [GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret) ' operationId: GetIPSecConnectionDeviceConfig parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' responses: 200: description: The configuration information was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnectionDeviceConfig' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetIPSecConnectionDeviceConfig tags: - virtualNetwork x-example: 'GET /20160918/ipsecConnections/<ipscId>/deviceConfig Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-client-retries-enabled: true /ipsecConnections/{ipscId}/deviceStatus: get: description: 'Deprecated. To get the tunnel status, instead use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel). ' operationId: GetIPSecConnectionDeviceStatus parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' responses: 200: description: The status was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnectionDeviceStatus' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetIPSecConnectionDeviceStatus tags: - virtualNetwork x-example: 'GET /20160918/ipsecConnections/<ipscId>/deviceStatus Host: iaas.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-client-retries-enabled: true /ipsecConnections/{ipscId}/tunnels: get: description: 'Lists the tunnel information for the specified IPSec connection. ' operationId: ListIPSecConnectionTunnels parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/IPSecConnectionTunnel' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListIPSecConnectionTunnels tags: - virtualNetwork x-obmcs-client-retries-enabled: true /ipsecConnections/{ipscId}/tunnels/{tunnelId}: get: description: 'Gets the specified tunnel''s information. The resulting object does not include the tunnel''s shared secret (pre-shared key). To retrieve that, use [GetIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/GetIPSecConnectionTunnelSharedSecret). ' operationId: GetIPSecConnectionTunnel parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' responses: 200: description: The information was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnectionTunnel' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetIPSecConnectionTunnel tags: - virtualNetwork x-obmcs-client-retries-enabled: true put: description: "Updates the specified tunnel. This operation lets you change tunnel attributes such as the\nrouting type (BGP dynamic routing or static routing). Here are some important notes:\n\n * If you change the tunnel's routing type or BGP session configuration, the tunnel will go\n down while it's reprovisioned.\n\n * If you want to switch the tunnel's `routing` from `STATIC` to `BGP`, make sure the tunnel's\n BGP session configuration attributes have been set ([bgpSessionConfig](#/en/iaas/latest/datatypes/BgpSessionInfo)).\n\n * If you want to switch the tunnel's `routing` from `BGP` to `STATIC`, make sure the\n [IPSecConnection](#/en/iaas/latest/IPSecConnection/) already has at least one valid CIDR\n static route.\n" operationId: UpdateIPSecConnectionTunnel parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The IPSec connection tunnel was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnectionTunnel' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateIPSecConnectionTunnelDetails tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIPSecConnectionTunnelDetails' description: Details object for updating a IPSecConnection tunnel's details. required: true /ipsecConnections/{ipscId}/tunnels/{tunnelId}/error: get: description: 'Gets the identified error for the specified IPSec tunnel ID. ' operationId: GetIPSecConnectionTunnelError parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' responses: 200: description: The tunnel error was successfully returned. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnectionTunnelErrorDetails' 204: description: No tunnel errors found. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetIPSecConnectionTunnelError tags: - virtualNetwork x-obmcs-client-retries-enabled: true /ipsecConnections/{ipscId}/tunnels/{tunnelId}/routes: get: description: 'The routes advertised to the on-premises network and the routes received from the on-premises network. ' operationId: ListIPSecConnectionTunnelRoutes parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/BgpRouteAdvertiserQueryParam' responses: 200: description: The tunnel routes were retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For list pagination. A pagination token to get the total number of results available. ' schema: type: integer content: application/json: schema: items: $ref: '#/components/schemas/TunnelRouteSummary' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListIPSecConnectionTunnelRoutes tags: - virtualNetwork x-obmcs-client-retries-enabled: true /ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret: get: description: 'Gets the specified tunnel''s shared secret (pre-shared key). To get other information about the tunnel, use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel). ' operationId: GetIPSecConnectionTunnelSharedSecret parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' responses: 200: description: The information was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnectionTunnelSharedSecret' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetIPSecConnectionTunnelSharedSecret tags: - virtualNetwork x-obmcs-client-retries-enabled: true put: description: 'Updates the shared secret (pre-shared key) for the specified tunnel. **Important:** If you change the shared secret, the tunnel will go down while it''s reprovisioned. ' operationId: UpdateIPSecConnectionTunnelSharedSecret parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The IPSec connection tunnel's shared secret was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IPSecConnectionTunnelSharedSecret' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateIPSecConnectionTunnelSharedSecret tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIPSecConnectionTunnelSharedSecretDetails' description: Details object for updating a IPSec connection tunnel's sharedSecret. required: true /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig: get: description: 'Gets the set of CPE configuration answers for the tunnel, which the customer provided in [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig). To get the full set of content for the tunnel (any answers merged with the template of other information specific to the CPE device type), use [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent). ' operationId: GetTunnelCpeDeviceConfig parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The information was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TunnelCpeDeviceConfig' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetTunnelCpeDeviceConfig tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/TunnelCpeDeviceConfig' put: description: 'Creates or updates the set of CPE configuration answers for the specified tunnel. The answers correlate to the questions that are specific to the CPE device type (see the `parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)). ' operationId: UpdateTunnelCpeDeviceConfig parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Updating the Tunnel CpeDevice Config Details. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TunnelCpeDeviceConfig' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateTunnelCpeDeviceConfig tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTunnelCpeDeviceConfigDetails' description: Request to input the tunnel's cpe configuration parameters required: true /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig/content: get: description: "Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a\nnetwork engineer configure the actual CPE device (for example, a hardware router) that the specified\nIPSec tunnel terminates on.\n\nThe rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the\n[Cpe](#/en/iaas/latest/Cpe/) used by the specified [IPSecConnection](#/en/iaas/latest/IPSecConnection/)\nmust have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content\noptionally includes answers that the customer provides (see\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig)),\nmerged with a template of other information specific to the CPE device type.\n\nThe operation returns configuration information for only the specified IPSec tunnel.\nHere are other similar operations:\n\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n returns CPE configuration content for all tunnels in a single IPSec connection.\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n returns CPE configuration content for *all* IPSec connections that use a specific CPE.\n" operationId: GetTunnelCpeDeviceConfigContent parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The information was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: text/plain; charset=utf-8: schema: format: binary type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetTunnelCpeDeviceConfigContent tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/TunnelCpeDeviceConfig' /ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelSecurityAssociations: get: description: 'Lists the tunnel security associations information for the specified IPSec tunnel ID. ' operationId: ListIPSecConnectionTunnelSecurityAssociations parameters: - $ref: '#/components/parameters/IPSecConnectionIdPathParam' - $ref: '#/components/parameters/IPSecConnectionTunnelIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-total-items: description: 'For list pagination. A pagination token to get the total number of results available. ' schema: type: integer content: application/json: schema: items: $ref: '#/components/schemas/TunnelSecurityAssociationSummary' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListIPSecConnectionTunnelSecurityAssociations tags: - virtualNetwork x-obmcs-client-retries-enabled: true /ipv6: get: description: "Lists the [IPv6](#/en/iaas/latest/Ipv6/) objects based\non one of these filters:\n\n * Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n * Both IPv6 address and subnet OCID: This lets you get an `Ipv6` object based on its private\n IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetIpv6](#/en/iaas/latest/Ipv6/GetIpv6) requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n" operationId: ListIpv6s parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/IpAddressOptionalQueryParam' - $ref: '#/components/parameters/SubnetIdOptionalQueryParam' - $ref: '#/components/parameters/VnicIdOptionalQueryParam' - $ref: '#/components/parameters/IpStateOptionalQueryParam' - $ref: '#/components/parameters/LifetimeOptionalQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Ipv6' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListIpv6s tags: - virtualNetwork post: description: 'Creates an IPv6 for the specified VNIC. ' operationId: CreateIpv6 parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The IPv6 was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Ipv6' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateIpv6 tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIpv6Details' description: Create IPv6 details. required: true /ipv6/actions/bulkCreateIpv6s: post: description: 'Create new IPv6s in bulk for a VNIC or subnet. ' operationId: BulkCreateIpv6s parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to create IPv6s in bulk was successfully received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BulkCreateIpv6s tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Ipv6' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkCreateIpv6sDetails' description: Create Ipv6s in bulk. required: true /ipv6/actions/bulkDeleteIpv6s: post: description: 'Unassign and delete IPv6s for a VNIC in bulk. ' operationId: BulkDeleteIpv6s parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to delete IPv6s in bulk was successfully received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BulkDeleteIpv6s tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Ipv6' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkDeleteIpv6sDetails' description: Details of the IPv6s to delete. required: true /ipv6/actions/bulkDetachIpv6s: post: description: 'Detach the specified IPv6s. ' operationId: BulkDetachIpv6s parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to detach IPv6s in bulk was successfully received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BulkDetachIpv6s tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Ipv6' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkDetachIpv6sDetails' description: Details needed to detach IPv6s in bulk. required: true /ipv6/actions/bulkUpdateIpv6s: post: description: 'Updates the specified IPv6s in bulk. ' operationId: BulkUpdateIpv6s parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to update IPv6s in bulk was successfully received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BulkUpdateIpv6s tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/Ipv6' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkUpdateIpv6sDetails' description: Details of the IPv6s to update. required: true /ipv6/{ipv6Id}: delete: description: 'Unassigns and deletes the specified IPv6. You must specify the object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm). The IPv6 address is returned to the subnet''s pool of available addresses. ' operationId: DeleteIpv6 parameters: - $ref: '#/components/parameters/Ipv6IdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The IPv6 was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteIpv6 tags: - virtualNetwork get: description: 'Gets the specified IPv6. You must specify the object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm). Alternatively, you can get the object by using [ListIpv6s](#/en/iaas/latest/Ipv6/ListIpv6s) with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetIpv6 parameters: - $ref: '#/components/parameters/Ipv6IdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The IPv6 was retrievd. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Ipv6' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetIpv6 tags: - virtualNetwork put: description: "Updates the specified IPv6. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n * Move an IPv6 to a different VNIC in the same subnet.\n * Enable/disable internet access for an IPv6.\n * Change the display name for an IPv6.\n * Update resource tags for an IPv6.\n" operationId: UpdateIpv6 parameters: - $ref: '#/components/parameters/Ipv6IdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The IPv6 was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Ipv6' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateIpv6 tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIpv6Details' description: IPv6 details to be updated. required: true /ipv6/{ipv6Id}/actions/detach: post: description: 'Unassign the specified IPv6 address from Virtual Network Interface Card (VNIC). You must specify the IPv6 [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: Ipv6VnicDetach parameters: - $ref: '#/components/parameters/Ipv6IdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The IPv6 was detached. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Ipv6' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Ipv6VnicDetach tags: - virtualNetwork x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/Ipv6' /localPeeringGateways: get: description: 'Lists the local peering gateways (LPGs) for the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment. ' operationId: ListLocalPeeringGateways parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/LocalPeeringGateway' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListLocalPeeringGateways tags: - virtualNetwork post: description: 'Creates a new local peering gateway (LPG) for the specified VCN. ' operationId: CreateLocalPeeringGateway parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The local peering gateway was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LocalPeeringGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateLocalPeeringGateway tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateLocalPeeringGatewayDetails' description: Details for creating a new local peering gateway. required: true /localPeeringGateways/{localPeeringGatewayId}: delete: description: 'Deletes the specified local peering gateway (LPG). This is an asynchronous operation; the local peering gateway''s `lifecycleState` changes to TERMINATING temporarily until the local peering gateway is completely removed. ' operationId: DeleteLocalPeeringGateway parameters: - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The local peering gateway is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteLocalPeeringGateway tags: - virtualNetwork get: description: Gets the specified local peering gateway's information. operationId: GetLocalPeeringGateway parameters: - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' responses: 200: description: The local peering gateway was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LocalPeeringGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetLocalPeeringGateway tags: - virtualNetwork put: description: 'Updates the specified local peering gateway (LPG). ' operationId: UpdateLocalPeeringGateway parameters: - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The local peering gateway was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/LocalPeeringGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateLocalPeeringGateway tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateLocalPeeringGatewayDetails' description: Details object for updating a local peering gateway. required: true /localPeeringGateways/{localPeeringGatewayId}/actions/changeCompartment: post: description: 'Moves a local peering gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeLocalPeeringGatewayCompartment parameters: - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The local peering gateway has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeLocalPeeringGatewayCompartment tags: - virtualNetwork x-related-resource: '#/definitions/LocalPeeringGateway' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeLocalPeeringGatewayCompartmentDetails' description: Request to change the compartment of a given local peering gateway. required: true /localPeeringGateways/{localPeeringGatewayId}/actions/connect: post: description: 'Connects this local peering gateway (LPG) to another one in the same region. This operation must be called by the VCN administrator who is designated as the *requestor* in the peering relationship. The *acceptor* must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor''s compartment. Without that permission, this operation will fail. For more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). ' operationId: ConnectLocalPeeringGateways parameters: - $ref: '#/components/parameters/LocalPeeringGatewayIdPathParam' responses: 204: description: The connect request was accepted and a peering is being established. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ConnectLocalPeeringGateways tags: - virtualNetwork x-related-resource: '#/definitions/LocalPeeringGateway' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectLocalPeeringGatewaysDetails' description: Details regarding the local peering gateway to connect. required: true /natGateways: x-obmcs-client-retries-enabled: true get: description: 'Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN. ' operationId: ListNatGateways parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to return only resources that match the specified lifecycle state. The value is case insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/NatGateway/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/NatGateway' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListNatGateways tags: - virtualNetwork post: description: 'Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the NAT gateway as the rule''s target. See [Route Table](#/en/iaas/latest/RouteTable/). ' operationId: CreateNatGateway parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The NAT gateway was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NatGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateNatGateway tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNatGatewayDetails' description: Details for creating a NAT gateway. required: true /natGateways/{natGatewayId}: x-obmcs-client-retries-enabled: true delete: description: 'Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there must not be a route rule that lists the NAT gateway as a target. This is an asynchronous operation. The NAT gateway''s `lifecycleState` will change to TERMINATING temporarily until the NAT gateway is completely removed. ' operationId: DeleteNatGateway parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/NatGatewayIdPathParam' responses: 204: description: The NAT gateway is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteNatGateway tags: - virtualNetwork get: description: Gets the specified NAT gateway's information. operationId: GetNatGateway parameters: - $ref: '#/components/parameters/NatGatewayIdPathParam' responses: 200: description: The NAT gateway was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NatGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetNatGateway tags: - virtualNetwork put: description: 'Updates the specified NAT gateway. ' operationId: UpdateNatGateway parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/NatGatewayIdPathParam' responses: 200: description: The NAT gateway was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NatGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateNatGateway tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNatGatewayDetails' description: Details object for updating a NAT gateway. required: true /natGateways/{natGatewayId}/actions/changeCompartment: x-obmcs-client-retries-enabled: true post: description: 'Moves a NAT gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeNatGatewayCompartment parameters: - $ref: '#/components/parameters/NatGatewayIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The NAT gateway has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeNatGatewayCompartment tags: - virtualNetwork x-related-resource: '#/definitions/NatGateway' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeNatGatewayCompartmentDetails' description: Request to change the compartment of a given NAT Gateway. required: true /networkSecurityGroups: get: description: 'Lists either the network security groups in the specified compartment, or those associated with the specified VLAN. You must specify either a `vlanId` or a `compartmentId`, but not both. If you specify a `vlanId`, all other parameters are ignored. ' operationId: ListNetworkSecurityGroups parameters: - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/VlanIdOptionalQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to return only resources that match the specified lifecycle state. The value is case insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/NetworkSecurityGroup/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/NetworkSecurityGroup' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListNetworkSecurityGroups tags: - virtualNetwork post: description: 'Creates a new network security group for the specified VCN. ' operationId: CreateNetworkSecurityGroup parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The network security group was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkSecurityGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateNetworkSecurityGroup tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateNetworkSecurityGroupDetails' description: Details for creating a network security group. required: true /networkSecurityGroups/{networkSecurityGroupId}: delete: description: 'Deletes the specified network security group. The group must not contain any VNICs. To get a list of the VNICs in a network security group, use [ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics). Each returned [NetworkSecurityGroupVnic](#/en/iaas/latest/NetworkSecurityGroupVnic/) object contains both the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC and the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC''s parent resource (for example, the Compute instance that the VNIC is attached to). ' operationId: DeleteNetworkSecurityGroup parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' responses: 204: description: The network security group was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteNetworkSecurityGroup tags: - virtualNetwork x-related-resource: '#/definitions/NetworkSecurityGroup' get: description: 'Gets the specified network security group''s information. To list the VNICs in an NSG, see [ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics). To list the security rules in an NSG, see [ListNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/ListNetworkSecurityGroupSecurityRules). ' operationId: GetNetworkSecurityGroup parameters: - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' responses: 200: description: The network security group was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkSecurityGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetNetworkSecurityGroup tags: - virtualNetwork put: description: 'Updates the specified network security group. To add or remove an existing VNIC from the group, use [UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic). To add a VNIC to the group *when you create the VNIC*, specify the NSG''s [OCID](/iaas/Content/General/Concepts/identifiers.htm) during creation. For example, see the `nsgIds` attribute in [CreateVnicDetails](#/en/iaas/latest/datatypes/CreateVnicDetails). To add or remove security rules from the group, use [AddNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/AddNetworkSecurityGroupSecurityRules) or [RemoveNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/RemoveNetworkSecurityGroupSecurityRules). To edit the contents of existing security rules in the group, use [UpdateNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/UpdateNetworkSecurityGroupSecurityRules). ' operationId: UpdateNetworkSecurityGroup parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' responses: 200: description: The network security group was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkSecurityGroup' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateNetworkSecurityGroup tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNetworkSecurityGroupDetails' description: Details object for updating a network security group. required: true /networkSecurityGroups/{networkSecurityGroupId}/actions/addSecurityRules: post: description: 'Adds up to 25 security rules to the specified network security group. Adding more than 25 rules requires multiple operations. ' operationId: AddNetworkSecurityGroupSecurityRules parameters: - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' responses: 200: description: The security rules were added. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AddedNetworkSecurityGroupSecurityRules' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AddNetworkSecurityGroupSecurityRules tags: - virtualNetwork x-related-resource: '#/definitions/SecurityRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddNetworkSecurityGroupSecurityRulesDetails' description: Request with one or more security rules to be associated with the network security group. required: true /networkSecurityGroups/{networkSecurityGroupId}/actions/changeCompartment: post: description: 'Moves a network security group into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeNetworkSecurityGroupCompartment parameters: - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The network security group has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeNetworkSecurityGroupCompartment tags: - virtualNetwork x-related-resource: '#/definitions/NetworkSecurityGroup' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeNetworkSecurityGroupCompartmentDetails' description: Request to change the compartment of a network security group. required: true /networkSecurityGroups/{networkSecurityGroupId}/actions/removeSecurityRules: post: description: 'Removes one or more security rules from the specified network security group. ' operationId: RemoveNetworkSecurityGroupSecurityRules parameters: - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' responses: 200: description: The security rules are being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoveNetworkSecurityGroupSecurityRules tags: - virtualNetwork x-related-resource: '#/definitions/SecurityRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveNetworkSecurityGroupSecurityRulesDetails' description: 'Request with one or more security rules associated with the network security group that will be removed. ' required: true /networkSecurityGroups/{networkSecurityGroupId}/actions/updateSecurityRules: post: description: 'Updates one or more security rules in the specified network security group. ' operationId: UpdateNetworkSecurityGroupSecurityRules parameters: - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' responses: 200: description: The security rules were updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdatedNetworkSecurityGroupSecurityRules' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateNetworkSecurityGroupSecurityRules tags: - virtualNetwork x-related-resource: '#/definitions/SecurityRule' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateNetworkSecurityGroupSecurityRulesDetails' description: 'Request with one or more security rules associated with the network security group that will be updated. ' required: true /networkSecurityGroups/{networkSecurityGroupId}/securityRules: get: description: 'Lists the security rules in the specified network security group. ' operationId: ListNetworkSecurityGroupSecurityRules parameters: - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' - $ref: '#/components/parameters/SecurityRuleDirectionOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ListNetworkSecurityGroupSecurityRulesSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/SecurityRule' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListNetworkSecurityGroupSecurityRules tags: - virtualNetwork /networkSecurityGroups/{networkSecurityGroupId}/vnics: get: description: 'Lists the VNICs in the specified network security group. ' operationId: ListNetworkSecurityGroupVnics parameters: - $ref: '#/components/parameters/NetworkSecurityGroupIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/ListNetworkSecurityGroupVnicsSortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/NetworkSecurityGroupVnic' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListNetworkSecurityGroupVnics tags: - virtualNetwork /networkingTopology: get: description: Gets a virtual networking topology for the current region. operationId: GetNetworkingTopology parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/QueryCompartmentSubtreeQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/CacheControlHeader' responses: 200: description: The topology was successfully returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/NetworkingTopology' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get a Virtual Networking topology for the current region tags: - virtualNetwork /privateIps: get: description: "Lists the [PrivateIp](#/en/iaas/latest/PrivateIp/) objects based\non one of these filters:\n\n - Subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n - Both private IP address and subnet OCID: This lets\n you get a `privateIP` object based on its private IP\n address (for example, 10.0.3.3) and not its [OCID](/iaas/Content/General/Concepts/identifiers.htm). For comparison,\n [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp)\n requires the [OCID](/iaas/Content/General/Concepts/identifiers.htm).\n\nIf you're listing all the private IPs associated with a given subnet\nor VNIC, the response includes both primary and secondary private IPs.\n\nIf you are an Oracle Cloud VMware Solution customer and have VLANs\nin your VCN, you can filter the list by VLAN [OCID](/iaas/Content/General/Concepts/identifiers.htm). See [Vlan](#/en/iaas/latest/Vlan).\n" operationId: ListPrivateIps parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/IpAddressOptionalQueryParam' - $ref: '#/components/parameters/SubnetIdOptionalQueryParam' - $ref: '#/components/parameters/VnicIdOptionalQueryParam' - $ref: '#/components/parameters/IpStateOptionalQueryParam' - $ref: '#/components/parameters/LifetimeOptionalQueryParam' - $ref: '#/components/parameters/VlanIdOptionalQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/PrivateIp' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListPrivateIps tags: - virtualNetwork post: description: 'Creates a private IP. For more information about private IPs, see [IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm). ' operationId: CreatePrivateIp parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The private IP was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreatePrivateIp tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePrivateIpDetails' description: Create private IP details. required: true /privateIps/actions/bulkCreatePrivateIps: post: description: 'Create secondary private IPv4 addresses. ' operationId: BulkCreatePrivateIps parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to create private IPs in bulk was received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BulkCreatePrivateIps tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/PrivateIp' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkCreatePrivateIpsDetails' description: Details used to create secondary private IPs. required: true /privateIps/actions/bulkDeletePrivateIps: post: description: 'Unassign and delete secondary private IPv4s for a VNIC. ' operationId: BulkDeletePrivateIps parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to bulk delete private IPs was received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BulkDeletePrivateIps tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/PrivateIp' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkDeletePrivateIpsDetails' description: Details of the secondary IPv4 addresses to delete. required: true /privateIps/actions/bulkDetachPrivateIps: post: description: 'Unassign the specified private IP addresses from the Virtual Network Interface Card (VNIC). You must specify the PrivateIP object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: BulkDetachPrivateIps parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to bulk detach private IPs was received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DetachPrivateIps tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/PrivateIp' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkDetachPrivateIpsDetails' description: The secondary IPv4 addresses to detach. required: true /privateIps/actions/bulkUpdatePrivateIps: post: description: Update existing secondary private IPv4s for a VNIC. operationId: BulkUpdatePrivateIps parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request to bulk update Private IPs was received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdatePrivateIps tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-obmcs-terraform: actionType: SPECIAL_UPDATE x-related-resource: '#/definitions/PrivateIp' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkUpdatePrivateIpsDetails' description: Details of the secondary IPv4 addresses to update. required: true /privateIps/{privateIpId}: delete: description: 'Unassigns and deletes the specified private IP. You must specify the object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm). The private IP address is returned to the subnet''s pool of available addresses. This operation cannot be used with primary private IPs, which are automatically unassigned and deleted when the VNIC is terminated. **Important:** If a secondary private IP is the [target of a route rule](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip), unassigning it from the VNIC causes that route rule to blackhole and the traffic will be dropped. ' operationId: DeletePrivateIp parameters: - $ref: '#/components/parameters/PrivateIpIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The private IP is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeletePrivateIp tags: - virtualNetwork get: description: 'Gets the specified private IP. You must specify the object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm). Alternatively, you can get the object by using [ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) with the private IP address (for example, 10.0.3.3) and subnet [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetPrivateIp parameters: - $ref: '#/components/parameters/PrivateIpIdPathParam' responses: 200: description: The private IP. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetPrivateIp tags: - virtualNetwork put: description: "Updates the specified private IP. You must specify the object's [OCID](/iaas/Content/General/Concepts/identifiers.htm).\nUse this operation if you want to:\n\n - Move a secondary private IP to a different VNIC in the same subnet.\n - Change the display name for a secondary private IP.\n - Change the hostname for a secondary private IP.\n\nThis operation cannot be used with primary private IPs.\nTo update the hostname for the primary IP on a VNIC, use\n[UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n" operationId: UpdatePrivateIp parameters: - $ref: '#/components/parameters/PrivateIpIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The private IP was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdatePrivateIp tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePrivateIpDetails' description: Private IP details. required: true /privateIps/{privateIpId}/actions/detach: post: description: 'Unassign the specified PrivateIP address from Virtual Network Interface Card (VNIC). You must specify the PrivateIP [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: PrivateIpVnicDetach parameters: - $ref: '#/components/parameters/PrivateIpIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The private IP was detached. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PrivateIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: PrivateIpVnicDetach tags: - virtualNetwork x-obmcs-terraform: actionType: UPDATE_FIELD x-related-resource: '#/definitions/PrivateIp' /publicIpPools: get: description: 'Lists the public IP pools in the specified compartment. You can filter the list using query parameters. ' operationId: ListPublicIpPools parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByByoipRangeIdQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIpPoolCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListPublicIpPools tags: - virtualNetwork x-related-resource: '#/definitions/PublicIpPool' post: description: 'Creates a public IP pool. ' operationId: CreatePublicIpPool parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The public IP pool was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIpPool' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreatePublicIpPool tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePublicIpPoolDetails' description: Create Public Ip Pool details required: true /publicIpPools/{publicIpPoolId}: delete: description: 'Deletes the specified public IP pool. To delete a public IP pool it must not have any active IP address allocations. You must specify the object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm) when deleting an IP pool. ' operationId: DeletePublicIpPool parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PublicIpPoolIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The public IP pool was deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeletePublicIpPool tags: - virtualNetwork x-related-resource: '#/definitions/PublicIpPool' get: description: 'Gets the specified `PublicIpPool` object. You must specify the object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' operationId: GetPublicIpPool parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PublicIpPoolIdPathParam' responses: 200: description: The `PublicIpPool` object was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIpPool' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetPublicIpPool tags: - virtualNetwork put: description: 'Updates the specified public IP pool. ' operationId: UpdatePublicIpPool parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PublicIpPoolIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The public IP pool was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIpPool' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdatePublicIpPool tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePublicIpPoolDetails' description: Public IP pool details. required: true /publicIpPools/{publicIpPoolId}/actions/addCapacity: post: description: 'Adds some or all of a CIDR block to a public IP pool. The CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool. ' operationId: AddPublicIpPoolCapacity parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PublicIpPoolIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The CIDR block was added to the IP pool. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIpPool' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AddPublicIpPoolCapacity tags: - virtualNetwork x-related-resource: '#/definitions/PublicIpPool' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddPublicIpPoolCapacityDetails' description: Byoip Range prefix and a cidr from it required: true /publicIpPools/{publicIpPoolId}/actions/changeCompartment: post: description: 'Moves a public IP pool to a different compartment. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangePublicIpPoolCompartment parameters: - $ref: '#/components/parameters/PublicIpPoolIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The public IP Pool was moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangePublicIpPoolCompartment tags: - virtualNetwork x-related-resource: '#/definitions/PublicIpPool' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePublicIpPoolCompartmentDetails' description: Request to change the compartment of a public IP pool. required: true /publicIpPools/{publicIpPoolId}/actions/removeCapacity: post: description: 'Removes a CIDR block from the referenced public IP pool. ' operationId: RemovePublicIpPoolCapacity parameters: - $ref: '#/components/parameters/PublicIpPoolIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The CIDR block was removed from the IP pool. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIpPool' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemovePublicIpPoolCapacity tags: - virtualNetwork x-related-resource: '#/definitions/PublicIpPool' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemovePublicIpPoolCapacityDetails' description: The CIDR block to remove from the IP pool. required: true /publicIps: get: description: "Lists the [PublicIp](#/en/iaas/latest/PublicIp/) objects\nin the specified compartment. You can filter the list by using query parameters.\n\nTo list your reserved public IPs:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `RESERVED`\n\nTo list the ephemeral public IPs assigned to a regional entity such as a NAT gateway:\n * Set `scope` = `REGION` (required)\n * Leave the `availabilityDomain` parameter empty\n * Set `lifetime` = `EPHEMERAL`\n\nTo list the ephemeral public IPs assigned to private IPs:\n * Set `scope` = `AVAILABILITY_DOMAIN` (required)\n * Set the `availabilityDomain` parameter to the desired availability domain (required)\n * Set `lifetime` = `EPHEMERAL`\n\n**Note:** An ephemeral public IP assigned to a private IP\nis always in the same availability domain and compartment as the private IP.\n" operationId: ListPublicIps parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PublicIpScopeQueryParam' - $ref: '#/components/parameters/AvailabilityDomainQueryParam' - $ref: '#/components/parameters/PublicIpLifetimeQueryParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/FilterByPublicIpPoolIdQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/PublicIp' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListPublicIps tags: - virtualNetwork post: description: 'Creates a public IP. Use the `lifetime` property to specify whether it''s an ephemeral or reserved public IP. For information about limits on how many you can create, see [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). * **For an ephemeral public IP assigned to a private IP:** You must also specify a `privateIpId` with the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the primary private IP you want to assign the public IP to. The public IP is created in the same availability domain as the private IP. An ephemeral public IP must always be assigned to a private IP, and only to the *primary* private IP on a VNIC, not a secondary private IP. Exception: If you create a [NatGateway](#/en/iaas/latest/NatGateway/), Oracle automatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove. * **For a reserved public IP:** You may also optionally assign the public IP to a private IP by specifying `privateIpId`. Or you can later assign the public IP with [UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp). **Note:** When assigning a public IP to a private IP, the private IP must not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned. Also, for reserved public IPs, the optional assignment part of this operation is asynchronous. Poll the public IP''s `lifecycleState` to determine if the assignment succeeded. ' operationId: CreatePublicIp parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The public IP was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreatePublicIp tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreatePublicIpDetails' description: Create public IP details. required: true /publicIps/actions/getByIpAddress: post: description: 'Gets the public IP based on the public IP address (for example, 203.0.113.2). **Note:** If you''re fetching a reserved public IP that is in the process of being moved to a different private IP, the service returns the public IP object with `lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP. ' operationId: GetPublicIpByIpAddress responses: 200: description: The public IP was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetPublicIpByIpAddress tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/GetPublicIpByIpAddressDetails' description: IP address details for fetching the public IP. required: true /publicIps/actions/getByPrivateIpId: post: description: 'Gets the public IP assigned to the specified private IP. You must specify the OCID of the private IP. If no public IP is assigned, a 404 is returned. **Note:** If you''re fetching a reserved public IP that is in the process of being moved to a different private IP, and you provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the original private IP, this operation returns a 404. If you instead provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP, or if you instead call [GetPublicIp](#/en/iaas/latest/PublicIp/GetPublicIp) or [GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress), the service returns the public IP object with `lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP. ' operationId: GetPublicIpByPrivateIpId responses: 200: description: The public IP was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetPublicIpByPrivateIpId tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/GetPublicIpByPrivateIpIdDetails' description: Private IP details for fetching the public IP. required: true /publicIps/{publicIpId}: delete: description: 'Unassigns and deletes the specified public IP (either ephemeral or reserved). You must specify the object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm). The public IP address is returned to the Oracle Cloud Infrastructure public IP pool. **Note:** You cannot update, unassign, or delete the public IP that Oracle automatically assigned to an entity for you (such as a load balancer or NAT gateway). The public IP is automatically deleted if the assigned entity is terminated. For an assigned reserved public IP, the initial unassignment portion of this operation is asynchronous. Poll the public IP''s `lifecycleState` to determine if the operation succeeded. If you want to simply unassign a reserved public IP and return it to your pool of reserved public IPs, instead use [UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp). ' operationId: DeletePublicIp parameters: - $ref: '#/components/parameters/PublicIpIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The public IP is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeletePublicIp tags: - virtualNetwork get: description: 'Gets the specified public IP. You must specify the object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm). Alternatively, you can get the object by using [GetPublicIpByIpAddress](#/en/iaas/latest/PublicIp/GetPublicIpByIpAddress) with the public IP address (for example, 203.0.113.2). Or you can use [GetPublicIpByPrivateIpId](#/en/iaas/latest/PublicIp/GetPublicIpByPrivateIpId) with the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is assigned to. **Note:** If you''re fetching a reserved public IP that is in the process of being moved to a different private IP, the service returns the public IP object with `lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the target private IP. ' operationId: GetPublicIp parameters: - $ref: '#/components/parameters/PublicIpIdPathParam' responses: 200: description: The public IP was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetPublicIp tags: - virtualNetwork put: description: 'Updates the specified public IP. You must specify the object''s [OCID](/iaas/Content/General/Concepts/identifiers.htm). Use this operation if you want to: * Assign a reserved public IP in your pool to a private IP. * Move a reserved public IP to a different private IP. * Unassign a reserved public IP from a private IP (which returns it to your pool of reserved public IPs). * Change the display name or tags for a public IP. Assigning, moving, and unassigning a reserved public IP are asynchronous operations. Poll the public IP''s `lifecycleState` to determine if the operation succeeded. **Note:** When moving a reserved public IP, the target private IP must not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned. Also, the initial unassignment from the original private IP always succeeds, but the assignment to the target private IP is asynchronous and could fail silently (for example, if the target private IP is deleted or has a different public IP assigned to it in the interim). If that occurs, the public IP remains unassigned and its `lifecycleState` switches to AVAILABLE (it is not reassigned to its original private IP). You must poll the public IP''s `lifecycleState` to determine if the move succeeded. Regarding ephemeral public IPs: * If you want to assign an ephemeral public IP to a primary private IP, use [CreatePublicIp](#/en/iaas/latest/PublicIp/CreatePublicIp). * You can''t move an ephemeral public IP to a different private IP. * If you want to unassign an ephemeral public IP from its private IP, use [DeletePublicIp](#/en/iaas/latest/PublicIp/DeletePublicIp), which unassigns and deletes the ephemeral public IP. **Note:** If a public IP is assigned to a secondary private IP (see [PrivateIp](#/en/iaas/latest/PrivateIp)), and you move that secondary private IP to another VNIC, the public IP moves with it. **Note:** There''s a limit to the number of [public IPs](#/en/iaas/latest/PublicIp/) a VNIC or instance can have. If you try to move a reserved public IP to a VNIC or instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). ' operationId: UpdatePublicIp parameters: - $ref: '#/components/parameters/PublicIpIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The public IP was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PublicIp' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdatePublicIp tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePublicIpDetails' description: Public IP details. required: true /publicIps/{publicIpId}/actions/changeCompartment: post: description: 'Moves a public IP into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). This operation applies only to reserved public IPs. Ephemeral public IPs always belong to the same compartment as their VNIC and move accordingly. ' operationId: ChangePublicIpCompartment parameters: - $ref: '#/components/parameters/PublicIpIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The public IP has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangePublicIpCompartment tags: - virtualNetwork x-related-resource: '#/definitions/PublicIp' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePublicIpCompartmentDetails' description: Request to change the compartment of a Public IP. required: true /remotePeeringConnections: get: description: 'Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC''s compartment). ' operationId: ListRemotePeeringConnections parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DrgIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/RemotePeeringConnection' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListRemotePeeringConnections tags: - virtualNetwork x-obmcs-client-retries-enabled: true post: description: 'Creates a new remote peering connection (RPC) for the specified DRG. ' operationId: CreateRemotePeeringConnection parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The remote peering connection was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RemotePeeringConnection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateRemotePeeringConnection tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRemotePeeringConnectionDetails' description: Request to create peering connection to remote region required: true /remotePeeringConnections/{remotePeeringConnectionId}: delete: description: 'Deletes the remote peering connection (RPC). This is an asynchronous operation; the RPC''s `lifecycleState` changes to TERMINATING temporarily until the RPC is completely removed. ' operationId: DeleteRemotePeeringConnection parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' responses: 204: description: The RPC is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteRemotePeeringConnection tags: - virtualNetwork x-obmcs-client-retries-enabled: true get: description: 'Get the specified remote peering connection''s information. ' operationId: GetRemotePeeringConnection parameters: - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' responses: 200: description: The RPC was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RemotePeeringConnection' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetRemotePeeringConnection tags: - virtualNetwork x-obmcs-client-retries-enabled: true put: description: 'Updates the specified remote peering connection (RPC). ' operationId: UpdateRemotePeeringConnection parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' responses: 200: description: The RPC was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RemotePeeringConnection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateRemotePeeringConnection tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRemotePeeringConnectionDetails' description: Request to the update the peering connection to remote region required: true /remotePeeringConnections/{remotePeeringConnectionId}/actions/changeCompartment: post: description: 'Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeRemotePeeringConnectionCompartment parameters: - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The remote peering connection has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeRemotePeeringConnectionCompartment tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/RemotePeeringConnection' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRemotePeeringConnectionCompartmentDetails' description: Request to change the compartment of a remote peering connection. required: true /remotePeeringConnections/{remotePeeringConnectionId}/actions/connect: post: description: 'Connects this RPC to another one in a different region. This operation must be called by the VCN administrator who is designated as the *requestor* in the peering relationship. The *acceptor* must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to RPCs in the acceptor''s compartment. Without that permission, this operation will fail. For more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). ' operationId: ConnectRemotePeeringConnections parameters: - $ref: '#/components/parameters/RemotePeeringConnectionIdPathParam' responses: 204: description: The connect request was accepted and a peering is being established. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ConnectRemotePeeringConnections tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/RemotePeeringConnection' requestBody: content: application/json: schema: $ref: '#/components/schemas/ConnectRemotePeeringConnectionsDetails' description: 'Details to connect peering connection with peering connection from remote region ' required: true /routeTables: get: description: 'Lists the route tables in the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment. The response includes the default route table that automatically comes with each VCN in the specified compartment, plus any route tables you''ve created. ' operationId: ListRouteTables parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/RouteTable/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/RouteTable' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListRouteTables tags: - virtualNetwork post: description: 'Creates a new route table for the specified VCN. In the request you must also include at least one route rule for the new route table. For information on the number of rules you can have in a route table, see [Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For general information about route tables in your VCN and the types of targets you can use in route rules, see [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the route table to reside. Notice that the route table doesn''t have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you''re not sure which compartment to use, put the route table in the same compartment as the VCN. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the route table, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. ' operationId: CreateRouteTable parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The route table was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RouteTable' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateRouteTable tags: - virtualNetwork x-example: "POST /20160918/routeTables\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"MyRouteTable\",\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\",\n \"routeRules\" : [{\n \"cidrBlock\" : \"0.0.0.0/0\",\n \"networkEntityId\" : \"ocid1.internetgateway.oc1.phx.<unique_ID>\"\n }],\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateRouteTableDetails' description: Details for creating a new route table. required: true /routeTables/{rtId}: delete: description: 'Deletes the specified route table, but only if it''s not associated with a subnet. You can''t delete a VCN''s default route table. This is an asynchronous operation. The route table''s `lifecycleState` will change to TERMINATING temporarily until the route table is completely removed. ' operationId: DeleteRouteTable parameters: - $ref: '#/components/parameters/RouteTableIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The route table is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteRouteTable tags: - virtualNetwork get: description: Gets the specified route table's information. operationId: GetRouteTable parameters: - $ref: '#/components/parameters/RouteTableIdPathParam' responses: 200: description: The route table was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RouteTable' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetRouteTable tags: - virtualNetwork put: description: 'Updates the specified route table''s display name or route rules. Avoid entering confidential information. Note that the `routeRules` object you provide replaces the entire existing set of rules. ' operationId: UpdateRouteTable parameters: - $ref: '#/components/parameters/RouteTableIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The route table was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/RouteTable' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateRouteTable tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRouteTableDetails' description: Details object for updating a route table. required: true /routeTables/{rtId}/actions/changeCompartment: post: description: 'Moves a route table into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeRouteTableCompartment parameters: - $ref: '#/components/parameters/RouteTableIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The route table has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeRouteTableCompartment tags: - virtualNetwork x-related-resource: '#/definitions/RouteTable' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeRouteTableCompartmentDetails' description: Request to change the compartment of a given route table. required: true /securityLists: get: description: 'Lists the security lists in the specified VCN and compartment. If the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment. ' operationId: ListSecurityLists parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/SecurityList/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/SecurityList' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListSecurityLists tags: - virtualNetwork post: description: 'Creates a new security list for the specified VCN. For more information about security lists, see [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm). For information on the number of rules you can have in a security list, see [Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the security list to reside. Notice that the security list doesn''t have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you''re not sure which compartment to use, put the security list in the same compartment as the VCN. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the security list, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. ' operationId: CreateSecurityList parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The security list has been created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateSecurityList tags: - virtualNetwork x-example: "POST /20160918/securityLists\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\",\n \"displayName\" : \"MyPrivateSubnetSecurityList\",\n \"ingressSecurityRules\" : [{\n \"protocol\" : \"6\",\n \"source\" : \"10.0.1.0/24\",\n \"tcpOptions\" : {\n \"destinationPortRange\" : {\n \"min\" : \"1521\",\n \"max\" : \"1521\"\n }\n }\n },{\n \"protocol\" : \"6\",\n \"source\" : \"10.0.2.0/24\",\n \"tcpOptions\" : {\n \"destinationPortRange\" : {\n \"min\" : \"1521\",\n \"max\" : \"1521\"\n }\n }\n }],\n \"egressSecurityRules\" : [{\n \"protocol\" : \"6\",\n \"destination\" : \"10.0.2.0/24\",\n \"tcpOptions\" : {\n \"destinationPortRange\" : {\n \"min\" : \"1521\",\n \"max\" : \"1521\"\n }\n }\n }],\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityListDetails' description: Details regarding the security list to create. required: true /securityLists/{securityListId}: delete: description: 'Deletes the specified security list, but only if it''s not associated with a subnet. You can''t delete a VCN''s default security list. This is an asynchronous operation. The security list''s `lifecycleState` will change to TERMINATING temporarily until the security list is completely removed. ' operationId: DeleteSecurityList parameters: - $ref: '#/components/parameters/SecurityListIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The security list is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteSecurityList tags: - virtualNetwork get: description: Gets the specified security list's information. operationId: GetSecurityList parameters: - $ref: '#/components/parameters/SecurityListIdPathParam' responses: 200: description: The security list was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityList' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetSecurityList tags: - virtualNetwork put: description: 'Updates the specified security list''s display name or rules. Avoid entering confidential information. Note that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire existing objects. ' operationId: UpdateSecurityList parameters: - $ref: '#/components/parameters/SecurityListIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The security list was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityList' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateSecurityList tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityListDetails' description: Updated details for the security list. required: true /securityLists/{securityListId}/actions/changeCompartment: post: description: 'Moves a security list into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeSecurityListCompartment parameters: - $ref: '#/components/parameters/SecurityListIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The security list has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeSecurityListCompartment tags: - virtualNetwork x-related-resource: '#/definitions/SecurityList' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSecurityListCompartmentDetails' description: Request to change the compartment of a given security list. required: true /serviceGateways: get: description: 'Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN. ' operationId: ListServiceGateways parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to return only resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/ServiceGateway/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/ServiceGateway' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListServiceGateways tags: - virtualNetwork post: description: 'Creates a new service gateway in the specified compartment. For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the service gateway to reside. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the service gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. Use the [ListServices](#/en/iaas/latest/Service/ListServices) operation to find service CIDR labels available in the region. ' operationId: CreateServiceGateway parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The service gateway was created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateServiceGateway tags: - virtualNetwork x-example: "POST /20160918/serviceGateways\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.compartment.oc1.phx.<unique_ID>\",\n \"vcnid\" : \"ocid1.vcn.oc1.phx.<unique_ID>\",\n \"displayName\" : \"MyServiceGateway\"\n \"services\":[\n { \"serviceId\": \"ocid1.service.oc1.phx.<unique_ID>\" }\n ]\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateServiceGatewayDetails' description: Details for creating a service gateway. required: true /serviceGateways/{serviceGatewayId}: delete: description: 'Deletes the specified service gateway. There must not be a route table that lists the service gateway as a target. ' operationId: DeleteServiceGateway parameters: - $ref: '#/components/parameters/ServiceGatewayIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The service gateway is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteServiceGateway tags: - virtualNetwork get: description: Gets the specified service gateway's information. operationId: GetServiceGateway parameters: - $ref: '#/components/parameters/ServiceGatewayIdPathParam' responses: 200: description: The service gateway was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceGateway' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetServiceGateway tags: - virtualNetwork put: description: 'Updates the specified service gateway. The information you provide overwrites the existing attributes of the gateway. ' operationId: UpdateServiceGateway parameters: - $ref: '#/components/parameters/ServiceGatewayIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The service gateway was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateServiceGateway tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateServiceGatewayDetails' description: Details object for updating a service gateway. required: true /serviceGateways/{serviceGatewayId}/actions/attachService: post: description: 'Adds the specified [Service](#/en/iaas/latest/Service/) to the list of enabled `Service` objects for the specified gateway. You must also set up a route rule with the `cidrBlock` of the `Service` as the rule''s destination and the service gateway as the rule''s target. See [Route Table](#/en/iaas/latest/RouteTable/). **Note:** The `AttachServiceId` operation is an easy way to add an individual `Service` to the service gateway. Compare it with [UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces the entire existing list of enabled `Service` objects with the list that you provide in the `Update` call. ' operationId: AttachServiceId parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ServiceGatewayIdPathParam' responses: 200: description: The service has been enabled for the service gateway. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AttachService tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceIdRequestDetails' description: ServiceId of Service to be attached to a service gateway. required: true /serviceGateways/{serviceGatewayId}/actions/changeCompartment: post: description: 'Moves a service gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeServiceGatewayCompartment parameters: - $ref: '#/components/parameters/ServiceGatewayIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The Service Gateway's compartment has been changed headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeServiceGatewayCompartment tags: - virtualNetwork x-related-resource: '#/definitions/ServiceGateway' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeServiceGatewayCompartmentDetails' description: Request to change the compartment of a given Service Gateway. required: true /serviceGateways/{serviceGatewayId}/actions/detachService: post: description: 'Removes the specified [Service](#/en/iaas/latest/Service/) from the list of enabled `Service` objects for the specified gateway. You do not need to remove any route rules that specify this `Service` object''s `cidrBlock` as the destination CIDR. However, consider removing the rules if your intent is to permanently disable use of the `Service` through this service gateway. **Note:** The `DetachServiceId` operation is an easy way to remove an individual `Service` from the service gateway. Compare it with [UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway), which replaces the entire existing list of enabled `Service` objects with the list that you provide in the `Update` call. `UpdateServiceGateway` also lets you block all traffic through the service gateway without having to remove each of the individual `Service` objects. ' operationId: DetachServiceId parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/ServiceGatewayIdPathParam' responses: 200: description: The service has been disabled for the service gateway. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/ServiceGateway' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DetachService tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/ServiceIdRequestDetails' description: ServiceId of Service to be detached from a service gateway. required: true /services: get: description: 'Lists the available [Service](#/en/iaas/latest/Service/) objects that you can enable for a service gateway in this region. ' operationId: ListServices parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Service' type: array 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListServices tags: - virtualNetwork /services/{serviceId}: get: description: 'Gets the specified [Service](#/en/iaas/latest/Service/) object. ' operationId: GetService parameters: - $ref: '#/components/parameters/ServiceIdPathParam' responses: 200: description: The `Service` is being retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Service' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetService tags: - virtualNetwork /subnetTopology: get: description: Gets a topology for a given subnet. operationId: GetSubnetTopology parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/QueryCompartmentSubtreeQueryParam' - $ref: '#/components/parameters/SubnetIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/CacheControlHeader' responses: 200: description: The topology was successfully returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SubnetTopology' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get virtual network subnet topology tags: - virtualNetwork /subnets: get: description: 'Lists the subnets in the specified VCN and the specified compartment. If the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment. ' operationId: ListSubnets parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Subnet/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Subnet' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListSubnets tags: - virtualNetwork post: description: 'Creates a new subnet in the specified VCN. You can''t change the size of the subnet after creation, so it''s important to think about the size of subnets you need before creating them. For more information, see [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm). For information on the number of subnets you can have in a VCN, see [Service Limits](/iaas/Content/General/Concepts/servicelimits.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the subnet to reside. Notice that the subnet doesn''t have to be in the same compartment as the VCN, route tables, or other Networking Service components. If you''re not sure which compartment to use, put the subnet in the same compartment as the VCN. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally associate a route table with the subnet. If you don''t, the subnet will use the VCN''s default route table. For more information about route tables, see [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm). You may optionally associate a security list with the subnet. If you don''t, the subnet will use the VCN''s default security list. For more information about security lists, see [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm). You may optionally associate a set of DHCP options with the subnet. If you don''t, the subnet will use the VCN''s default set. For more information about DHCP options, see [DHCP Options](/iaas/Content/Network/Tasks/managingDHCP.htm). You may optionally specify a *display name* for the subnet, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. You can also add a DNS label for the subnet, which is required if you want the Internet and VCN Resolver to resolve hostnames for instances in the subnet. For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). ' operationId: CreateSubnet parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The subnet was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Subnet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateSubnet tags: - virtualNetwork x-example: "POST /20160918/subnets\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"MySubnet\",\n \"cidrBlock\" : \"10.0.2.0/24\",\n \"availabilityDomain\" : \"crmS:PHX-AD-1\",\n \"routeTableId\" : \"ocid1.routetable.oc1.phx.<unique_ID>\",\n \"securityListIds\" : [ \"ocid1.securitylist.oc1.phx.<unique_ID>\" ],\n \"dhcpOptionsId\" : \"ocid1.dhcpoptions.oc1.phx.<unique_ID>\",\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSubnetDetails' description: Details for creating a subnet. required: true /subnets/{subnetId}: delete: description: 'Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous operation. The subnet''s `lifecycleState` will change to TERMINATING temporarily. If there are any instances in the subnet, the state will instead change back to AVAILABLE. ' operationId: DeleteSubnet parameters: - $ref: '#/components/parameters/SubnetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The subnet is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteSubnet tags: - virtualNetwork get: description: Gets the specified subnet's information. operationId: GetSubnet parameters: - $ref: '#/components/parameters/SubnetIdPathParam' responses: 200: description: The subnet was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Subnet' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetSubnet tags: - virtualNetwork put: description: 'Updates the specified subnet. ' operationId: UpdateSubnet parameters: - $ref: '#/components/parameters/SubnetIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The subnet was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Subnet' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateSubnet tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSubnetDetails' description: Details object for updating a subnet. required: true /subnets/{subnetId}/actions/addIpv4Cidr: post: description: 'Add an IPv4 prefix to a subnet. ' operationId: AddIpv4SubnetCidr parameters: - $ref: '#/components/parameters/SubnetIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request to add IPv4 prefix was queued. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: AddIpv4SubnetCidr tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Subnet' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddIpv4SubnetCidrDetails' description: Details object for adding an IPv4 prefix to a subnet. required: true /subnets/{subnetId}/actions/addIpv6Cidr: post: description: 'Add an IPv6 prefix to a subnet. ' operationId: AddIpv6SubnetCidr parameters: - $ref: '#/components/parameters/SubnetIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Request to add IPv6 prefix was queued. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: AddIpv6SubnetCidr tags: - virtualNetwork x-related-resource: '#/definitions/Subnet' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddSubnetIpv6CidrDetails' description: Details object for adding an IPv6 prefix to a subnet. required: true /subnets/{subnetId}/actions/changeCompartment: post: description: 'Moves a subnet into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeSubnetCompartment parameters: - $ref: '#/components/parameters/SubnetIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The subnet has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeSubnetCompartment tags: - virtualNetwork x-related-resource: '#/definitions/Subnet' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSubnetCompartmentDetails' description: Request to change the compartment of a given subnet. required: true /subnets/{subnetId}/actions/modifyIpv4Cidr: post: description: 'Updates the specified Ipv4 CIDR block of a Subnet. The new Ipv4 CIDR IP range must meet the following criteria: - Must be valid. - Must not overlap with another Ipv4 CIDR block in the Subnet or the on-premises network CIDR block. - Must not exceed the limit of Ipv4 CIDR blocks allowed per Subnet. - Must include IP addresses from the original CIDR block that are used in the VCN''s existing route rules. - No IP address in an existing subnet should be outside of the new CIDR block range. ' operationId: ModifyIpv4SubnetCidr parameters: - $ref: '#/components/parameters/SubnetIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: A request to update the SUBNET's IPv4 prefix subnet was queued. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ModifyIpv4SubnetCidr tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Subnet' requestBody: content: application/json: schema: $ref: '#/components/schemas/ModifyIpv4SubnetCidrDetails' description: Details object for updating a SUBNET IPv4 prefix. required: true /subnets/{subnetId}/actions/removeIpv4Cidr: post: description: 'Remove an IPv4 prefix from a subnet ' operationId: RemoveIpv4SubnetCidr parameters: - $ref: '#/components/parameters/SubnetIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: A request to remove an IPv4 prefix from the subnet was queued. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: RemoveIpv4SubnetCidr tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/Subnet' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveIpv4SubnetCidrDetails' description: Details object for removing an IPv4 SUBNET prefix. required: true /subnets/{subnetId}/actions/removeIpv6Cidr: post: description: 'Remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain. ' operationId: RemoveIpv6SubnetCidr parameters: - $ref: '#/components/parameters/SubnetIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: A request to remove an IPv6 prefix from the subnet was queued. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: RemoveIpv6SubnetCidr tags: - virtualNetwork x-related-resource: '#/definitions/Subnet' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveSubnetIpv6CidrDetails' description: Details object for removing an IPv6 SUBNET prefix. required: true /vcnTopology: get: description: Gets a virtual network topology for a given VCN. operationId: GetVcnTopology parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AccessLevelQueryParam' - $ref: '#/components/parameters/QueryCompartmentSubtreeQueryParam' - $ref: '#/components/parameters/VcnIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/IfNoneMatchHeader' - $ref: '#/components/parameters/CacheControlHeader' responses: 200: description: The topology was successfully returned. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VcnTopology' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: Get Virtual Network VCN topology tags: - virtualNetwork /vcns: get: description: 'Lists the virtual cloud networks (VCNs) in the specified compartment. ' operationId: ListVcns parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Vcn/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Vcn' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVcns tags: - virtualNetwork post: description: 'Creates a new virtual cloud network (VCN). For more information, see [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm). For the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria: - The CIDR blocks must be valid. - They must not overlap with each other or with the on-premises network CIDR block. - The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN. For a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in [RFC 1918](https://tools.ietf.org/html/rfc1918) (10.0.0.0/8, 172.16/12, and 192.168/16). Example: 172.16.0.0/16. The CIDR blocks can range from /16 to /30. For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the VCN to reside. Consult an Oracle Cloud Infrastructure administrator in your organization if you''re not sure which compartment to use. Notice that the VCN doesn''t have to be in the same compartment as the subnets or other Networking Service components. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the VCN, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. You can also add a DNS label for the VCN, which is required if you want the instances to use the Interent and VCN Resolver option for DNS in the VCN. For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for each is returned in the response. You can''t delete these default objects, but you can change their contents (that is, change the route rules, security list rules, and so on). The VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN or FastConnect. For more information, see [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). ' operationId: CreateVcn parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The VCN was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vcn' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVcn tags: - virtualNetwork x-example: "POST /20160918/vcns\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"cidrBlock\" : \"10.0.0.0/16\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"MyVcn\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVcnDetails' description: Details for creating a new VCN. required: true /vcns/{vcnId}: delete: description: 'Deletes the specified VCN. The VCN must be completely empty and have no attached gateways. This is an asynchronous operation. A deleted VCN''s `lifecycleState` changes to TERMINATING and then TERMINATED temporarily until the VCN is completely removed. A completely removed VCN does not appear in the results of a `ListVcns` operation and can''t be used in a `GetVcn` operation. ' operationId: DeleteVcn parameters: - $ref: '#/components/parameters/VcnIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The VCN is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVcn tags: - virtualNetwork get: description: Gets the specified VCN's information. operationId: GetVcn parameters: - $ref: '#/components/parameters/VcnIdPathParam' responses: 200: description: The VCN was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vcn' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVcn tags: - virtualNetwork put: description: 'Updates the specified VCN. ' operationId: UpdateVcn parameters: - $ref: '#/components/parameters/VcnIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The VCN was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vcn' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVcn tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVcnDetails' description: Details object for updating a VCN. required: true /vcns/{vcnId}/actions/addCidr: post: description: 'Adds a CIDR block to a VCN. The CIDR block you add: - Must be valid. - Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block. - Must not exceed the limit of CIDR blocks allowed per VCN. **Note:** Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN''s subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update. ' operationId: AddVcnCidr parameters: - $ref: '#/components/parameters/VcnIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request to add the CIDR block to the VCN was successfully received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: AddVcnCidr tags: - virtualNetwork x-related-resource: '#/definitions/Vcn' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddVcnCidrDetails' description: Details object for deleting a VCN CIDR. required: true /vcns/{vcnId}/actions/addIpv6Cidr: post: description: 'Add an IPv6 prefix to a VCN. The VCN size is always /56. AddIpv6VcnCidr supports adding Private IPv6 Prefix i.e. ULA or an IPv6 GUA assigned by Oracle or BYOIPv6 Prefix, only one of these per request. Once added the IPv6 prefix cannot be removed or modified. ' operationId: AddIpv6VcnCidr parameters: - $ref: '#/components/parameters/VcnIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: Add IPv6 prefix request has been queued. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: AddVcnIpv6Cidr tags: - virtualNetwork x-related-resource: '#/definitions/Vcn' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddVcnIpv6CidrDetails' description: 'Details object for adding an IPv6 VCN CIDR. ' /vcns/{vcnId}/actions/changeCompartment: post: description: 'Moves a VCN into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeVcnCompartment parameters: - $ref: '#/components/parameters/VcnIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The VCN has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeVcnCompartment tags: - virtualNetwork x-related-resource: '#/definitions/Vcn' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVcnCompartmentDetails' description: Request to change the compartment of a given VCN. required: true /vcns/{vcnId}/actions/modifyCidr: post: description: 'Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria: - Must be valid. - Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block. - Must not exceed the limit of CIDR blocks allowed per VCN. - Must include IP addresses from the original CIDR block that are used in the VCN''s existing route rules. - No IP address in an existing subnet should be outside of the new CIDR block range. **Note:** Modifying a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN''s subnets, VLANs, LPGs, or route tables during this operation. The time to completion can vary depending on the size of your network. Updating a small network could take about a minute, and updating a large network could take up to an hour. You can use the `GetWorkRequest` operation to check the status of the update. ' operationId: ModifyVcnCidr parameters: - $ref: '#/components/parameters/VcnIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request to update the VCN's CIDR block was successfully received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: ModifyVcnCidr tags: - virtualNetwork x-related-resource: '#/definitions/Vcn' requestBody: content: application/json: schema: $ref: '#/components/schemas/ModifyVcnCidrDetails' description: Details object for updating a VCN CIDR. required: true /vcns/{vcnId}/actions/removeCidr: post: description: 'Removes a specified CIDR block from a VCN. **Notes:** - You cannot remove a CIDR block if an IP address in its range is in use. - Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN''s subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the `GetWorkRequest` operation to check the status of the update. ' operationId: RemoveVcnCidr parameters: - $ref: '#/components/parameters/VcnIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request to remove the CIDR block from the VCN was successfully received. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: RemoveVcnCidr tags: - virtualNetwork x-related-resource: '#/definitions/Vcn' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveVcnCidrDetails' description: Details object for removing a VCN CIDR. required: true /vcns/{vcnId}/actions/removeIpv6Cidr: post: description: 'Removing an existing IPv6 prefix from a VCN. ' operationId: RemoveIpv6VcnCidr parameters: - $ref: '#/components/parameters/VcnIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' responses: 202: description: The request to remove the IPv6 prefix from the VCN was successfully received. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' summary: RemoveIpv6VcnCidr tags: - virtualNetwork x-related-resource: '#/definitions/Vcn' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveVcnIpv6CidrDetails' description: Details object for removing a VCN IPv6 prefix. /virtualCircuitBandwidthShapes: get: description: 'The operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment). ' operationId: ListVirtualCircuitBandwidthShapes parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VirtualCircuitBandwidthShape' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVirtualCircuitBandwidthShapes tags: - virtualNetwork x-obmcs-client-retries-enabled: true /virtualCircuits: get: description: 'Lists the virtual circuits in the specified compartment. ' operationId: ListVirtualCircuits parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - description: 'A filter to return only resources that match the specified lifecycle state. The value is case insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/VirtualCircuit/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VirtualCircuit' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVirtualCircuits tags: - virtualNetwork x-obmcs-client-retries-enabled: true post: description: 'Creates a new virtual circuit to use with Oracle Cloud Infrastructure FastConnect. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment where you want the virtual circuit to reside. If you''re not sure which compartment to use, put the virtual circuit in the same compartment with the DRG it''s using. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the virtual circuit. It does not have to be unique, and you can change it. Avoid entering confidential information. **Important:** When creating a virtual circuit, you specify a DRG for the traffic to flow through. Make sure you attach the DRG to your VCN and confirm the VCN''s routing sends traffic to the DRG. Otherwise traffic will not flow. For more information, see [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm). ' operationId: CreateVirtualCircuit parameters: - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The VirtualCircuit was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VirtualCircuit' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVirtualCircuit tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVirtualCircuitDetails' description: Details to create a VirtualCircuit. required: true /virtualCircuits/{virtualCircuitId}: delete: description: 'Deletes the specified virtual circuit. **Important:** If you''re using FastConnect via a provider, make sure to also terminate the connection with the provider, or else the provider may continue to bill you. ' operationId: DeleteVirtualCircuit parameters: - $ref: '#/components/parameters/VirtualCircuitIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 204: description: The virtual circuit is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVirtualCircuit tags: - virtualNetwork x-obmcs-client-retries-enabled: true get: description: Gets the specified virtual circuit's information. operationId: GetVirtualCircuit parameters: - $ref: '#/components/parameters/VirtualCircuitIdPathParam' responses: 200: description: The virtual circuit was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VirtualCircuit' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVirtualCircuit tags: - virtualNetwork x-obmcs-client-retries-enabled: true put: description: 'Updates the specified virtual circuit. This can be called by either the customer who owns the virtual circuit, or the provider (when provisioning or de-provisioning the virtual circuit from their end). The documentation for [UpdateVirtualCircuitDetails](#/en/iaas/latest/requests/UpdateVirtualCircuitDetails) indicates who can update each property of the virtual circuit. **Important:** If the virtual circuit is working and in the PROVISIONED state, updating any of the network-related properties (such as the DRG being used, the BGP ASN, and so on) will cause the virtual circuit''s state to switch to PROVISIONING and the related BGP session to go down. After Oracle re-provisions the virtual circuit, its state will return to PROVISIONED. Make sure you confirm that the associated BGP session is back up. For more information about the various states and how to test connectivity, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). To change the list of public IP prefixes for a public virtual circuit, use [BulkAddVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkAddVirtualCircuitPublicPrefixes) and [BulkDeleteVirtualCircuitPublicPrefixes](#/en/iaas/latest/VirtualCircuitPublicPrefix/BulkDeleteVirtualCircuitPublicPrefixes). Updating the list of prefixes does NOT cause the BGP session to go down. However, Oracle must verify the customer''s ownership of each added prefix before traffic for that prefix will flow across the virtual circuit. ' operationId: UpdateVirtualCircuit parameters: - $ref: '#/components/parameters/VirtualCircuitIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The virtual circuit was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/VirtualCircuit' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVirtualCircuit tags: - virtualNetwork x-obmcs-client-retries-enabled: true requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVirtualCircuitDetails' description: Update VirtualCircuit fields. required: true /virtualCircuits/{virtualCircuitId}/actions/bulkAddPublicPrefixes: post: description: 'Adds one or more customer public IP prefixes to the specified public virtual circuit. Use this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit)) to add prefixes to the virtual circuit. Oracle must verify the customer''s ownership of each prefix before traffic for that prefix will flow across the virtual circuit. ' operationId: BulkAddVirtualCircuitPublicPrefixes parameters: - $ref: '#/components/parameters/VirtualCircuitIdPathParam' responses: 204: description: Addition of public prefixes accepted. 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BulkAddVirtualCircuitPublicPrefixes tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/VirtualCircuitPublicPrefix' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkAddVirtualCircuitPublicPrefixesDetails' description: Request with publix prefixes to be added to the virtual circuit required: true /virtualCircuits/{virtualCircuitId}/actions/bulkDeletePublicPrefixes: post: description: 'Removes one or more customer public IP prefixes from the specified public virtual circuit. Use this operation (and not [UpdateVirtualCircuit](#/en/iaas/latest/VirtualCircuit/UpdateVirtualCircuit)) to remove prefixes from the virtual circuit. When the virtual circuit''s state switches back to PROVISIONED, Oracle stops advertising the specified prefixes across the connection. ' operationId: BulkDeleteVirtualCircuitPublicPrefixes parameters: - $ref: '#/components/parameters/VirtualCircuitIdPathParam' responses: 204: description: Deletion of public prefixes accepted. 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: BulkDeleteVirtualCircuitPublicPrefixes tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/VirtualCircuitPublicPrefix' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkDeleteVirtualCircuitPublicPrefixesDetails' description: Request with public prefixes to be deleted from the virtual circuit. required: true /virtualCircuits/{virtualCircuitId}/actions/changeCompartment: post: description: 'Moves a virtual circuit into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeVirtualCircuitCompartment parameters: - $ref: '#/components/parameters/VirtualCircuitIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The virtual circuit has been moved to the specified compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeVirtualCircuitCompartment tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/VirtualCircuit' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVirtualCircuitCompartmentDetails' description: Request to change the compartment of a virtual circuit. required: true /virtualCircuits/{virtualCircuitId}/associatedTunnels: get: description: Gets the specified virtual circuit's associatedTunnelsInfo. operationId: ListVirtualCircuitAssociatedTunnels parameters: - $ref: '#/components/parameters/VirtualCircuitIdPathParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: The virtual circuit's `associatedTunnelsInfo` was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VirtualCircuitAssociatedTunnelDetails' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVirtualCircuitAssociatedTunnels tags: - virtualNetwork x-obmcs-client-retries-enabled: true x-related-resource: '#/definitions/VirtualCircuitAssociatedTunnelDetails' /virtualCircuits/{virtualCircuitId}/crossConnectMappings: get: description: 'Lists the Cross Connect mapping Details for the specified virtual circuit. ' operationId: ListCrossConnectMappings parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/VirtualCircuitIdPathParam' responses: 200: description: The list is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/CrossConnectMappingDetailsCollection' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListCrossConnectMappings tags: - virtualNetwork x-obmcs-client-retries-enabled: true /virtualCircuits/{virtualCircuitId}/publicPrefixes: get: description: 'Lists the public IP prefixes and their details for the specified public virtual circuit. ' operationId: ListVirtualCircuitPublicPrefixes parameters: - $ref: '#/components/parameters/VirtualCircuitIdPathParam' - description: 'A filter to only return resources that match the given verification state. The state value is case-insensitive. ' in: query name: verificationState required: false x-obmcs-enumref: '#/definitions/VirtualCircuitPublicPrefix/verificationState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/VirtualCircuitPublicPrefix' type: array 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVirtualCircuitPublicPrefixes tags: - virtualNetwork x-obmcs-client-retries-enabled: true /vlans: get: description: 'Lists the VLANs in the specified VCN and the specified compartment. ' operationId: ListVlans parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/VcnIdQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Vlan/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Vlan' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVlans tags: - virtualNetwork post: description: 'Creates a VLAN in the specified VCN and the specified compartment. ' operationId: CreateVlan parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The VLAN was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vlan' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVlan tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVlanDetails' description: Details for creating a VLAN required: true /vlans/{vlanId}: delete: description: 'Deletes the specified VLAN, but only if there are no VNICs in the VLAN. ' operationId: DeleteVlan parameters: - $ref: '#/components/parameters/VlanIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The VLAN is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVlan tags: - virtualNetwork x-related-resource: '#/definitions/Vlan' get: description: Gets the specified VLAN's information. operationId: GetVlan parameters: - $ref: '#/components/parameters/VlanIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The VLAN was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vlan' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVlan tags: - virtualNetwork put: description: 'Updates the specified VLAN. Note that this operation might require changes to all the VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete. ' operationId: UpdateVlan parameters: - $ref: '#/components/parameters/VlanIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The VLAN was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vlan' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVlan tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVlanDetails' description: Details object for updating a subnet. required: true /vlans/{vlanId}/actions/changeCompartment: post: description: 'Moves a VLAN into a different compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeVlanCompartment parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/VlanIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The VLAN has been moved to the specified compartment. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeVlanCompartment tags: - virtualNetwork x-related-resource: '#/definitions/Vlan' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVlanCompartmentDetails' description: Request to change the compartment of a given VLAN. required: true /vnics/{vnicId}: get: description: 'Gets the information for the specified virtual network interface card (VNIC). You can get the VNIC [OCID](/iaas/Content/General/Concepts/identifiers.htm) from the [ListVnicAttachments](#/en/iaas/latest/VnicAttachment/ListVnicAttachments) operation. ' operationId: GetVnic parameters: - $ref: '#/components/parameters/VnicIdPathParam' responses: 200: description: The VNIC was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vnic' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVnic tags: - virtualNetwork put: description: 'Updates the specified VNIC. ' operationId: UpdateVnic parameters: - $ref: '#/components/parameters/VnicIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' responses: 200: description: The VNIC was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vnic' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVnic tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVnicDetails' description: Details object for updating a VNIC. required: true /vtaps: get: description: 'Lists the virtual test access points (VTAPs) in the specified compartment. ' operationId: ListVtaps parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/VcnIdOptionalQueryParam' - $ref: '#/components/parameters/VtapSourceIdOptionalQueryParam' - $ref: '#/components/parameters/VtapTargetIdOptionalQueryParam' - $ref: '#/components/parameters/VtapTargetIpOptionalQueryParam' - $ref: '#/components/parameters/VtapIsEnabledOptionalQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/FilterByDisplayNameQueryParam' - $ref: '#/components/parameters/FilterByVtapLifecycleStateQueryParam' responses: 200: description: The list of VTAPs is being retrieved. headers: opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/Vtap' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ListVtaps tags: - virtualNetwork post: description: 'Creates a virtual test access point (VTAP) in the specified compartment. For the purposes of access control, you must provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP. For more information about compartments and access control, see [Overview of the IAM Service](/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](/iaas/Content/General/Concepts/identifiers.htm). You may optionally specify a *display name* for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it. ' operationId: CreateVtap parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The VTAP was created. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vtap' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: CreateVtap tags: - virtualNetwork x-example: "POST /20160918/vtaps\nHost: iaas.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"displayName\" : \"MyVTAP\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVtapDetails' description: Details used to create a VTAP. required: true /vtaps/{vtapId}: delete: description: 'Deletes the specified VTAP. This is an asynchronous operation. The VTAP''s `lifecycleState` will change to TERMINATING temporarily until the VTAP is completely removed. ' operationId: DeleteVtap parameters: - $ref: '#/components/parameters/VtapIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The VTAP is being deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: DeleteVtap tags: - virtualNetwork x-related-resource: '#/definitions/Vtap' get: description: Gets the specified `Vtap` resource. operationId: GetVtap parameters: - $ref: '#/components/parameters/VtapIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The VTAP was retrieved. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vtap' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: GetVtap tags: - virtualNetwork put: description: 'Updates the specified VTAP''s display name or tags. ' operationId: UpdateVtap parameters: - $ref: '#/components/parameters/VtapIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The VTAP was updated. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Vtap' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: UpdateVtap tags: - virtualNetwork requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateVtapDetails' description: Details object for updating a VTAP. required: true /vtaps/{vtapId}/actions/changeCompartment: post: description: 'Moves a VTAP to a new compartment within the same tenancy. For information about moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes). ' operationId: ChangeVtapCompartment parameters: - $ref: '#/components/parameters/VtapIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The VTAP is being moved to the new compartment. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/DefaultError' summary: ChangeVtapCompartment tags: - virtualNetwork x-related-resource: '#/definitions/Vtap' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeVtapCompartmentDetails' description: Request to change the compartment that contains a VTAP. required: true components: schemas: CpeDeviceShapeDetail: description: 'The detailed information about a particular CPE device type. Compare with [CpeDeviceShapeSummary](#/en/iaas/latest/CpeDeviceShapeSummary/). ' properties: cpeDeviceInfo: $ref: '#/components/schemas/CpeDeviceInfo' cpeDeviceShapeId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. This value uniquely identifies the type of CPE device. ' maxLength: 255 minLength: 1 type: string parameters: description: 'For certain CPE devices types, the customer can provide answers to questions that are specific to the device type. This attribute contains a list of those questions. The Networking service merges the answers with other information and renders a set of CPE configuration content. To provide the answers, use [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig). ' items: $ref: '#/components/schemas/CpeDeviceConfigQuestion' type: array template: description: "A template of CPE device configuration information that will be merged with the customer's\nanswers to the questions to render the final CPE device configuration content. Also see:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n" minLength: 1 type: string ModifyVcnCidrDetails: description: 'Details for updating a CIDR block. ' properties: newCidrBlock: description: 'The new CIDR IP address. ' maxLength: 18 minLength: 9 type: string originalCidrBlock: description: 'The CIDR IP address to update. ' maxLength: 18 minLength: 9 type: string required: - originalCidrBlock - newCidrBlock IpInventorySubnetResourceCollection: description: The results returned by a `ListIpInventorySubnet` operation. properties: compartmentId: description: 'The compartment of the subnet. ' maxLength: 255 minLength: 1 type: string count: description: Specifies the count for the number of results for the response. format: int32 type: integer ipInventorySubnetResourceSummary: description: 'Lists `SubnetResourceSummary` objects. ' items: $ref: '#/components/schemas/IpInventorySubnetResourceSummary' type: array lastUpdatedTimestamp: description: 'The Timestamp of the latest update from the database in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string message: description: 'Indicates the status of the data. ' maxLength: 255 minLength: 1 type: string TunnelRouteSummary: description: 'A summary of the routes advertised to and received from the on-premises network. ' properties: advertiser: description: The source of the route advertisement. enum: - CUSTOMER - ORACLE type: string age: description: The age of the route. format: int64 type: integer asPath: description: A list of ASNs in AS_Path. items: type: integer type: array isBestPath: description: Indicates this is the best route. type: boolean prefix: description: The BGP network layer reachability information. maxLength: 255 minLength: 1 type: string ChangeSubnetCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the subnet to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId PeerRegionForRemotePeering: description: 'Details about a region that supports remote VCN peering. For more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). ' properties: name: description: 'The region''s name. Example: `us-phoenix-1` ' maxLength: 255 minLength: 1 type: string required: - name UpdateDrgRouteDistributionStatementsDetails: description: 'Details request to update statements in a route distribution. ' properties: statements: description: 'The route distribution statements to update, and the details to be updated. ' items: $ref: '#/components/schemas/UpdateDrgRouteDistributionStatementDetails' maxItems: 100 minItems: 0 type: array required: - statements PublicIpPoolSummary: description: Summary information about a public IP pool. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP pool. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool. maxLength: 255 minLength: 1 type: string lifecycleState: description: The public IP pool's current state. type: string x-obmcs-enumref: '#/definitions/PublicIpPool/lifecycleState' timeCreated: description: 'The date and time the public IP pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string UpdateIpv6Details: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isInternetAccessAllowed: default: true description: 'Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the IPv6 uses its public IP address for internet communication. If you switch this from `true` to `false`, the `publicIpAddress` attribute for the IPv6 becomes null. Example: `false` ' type: boolean lifetime: description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to reassign the IPv6 to. The VNIC must be in the same subnet as the current VNIC. ' maxLength: 255 minLength: 1 type: string UpdateIPSecConnectionDetails: properties: cpeLocalIdentifier: description: 'Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for `cpeLocalIdentifierType`. For information about why you''d provide this value, see [If Your CPE Is Behind a NAT Device](/iaas/Content/Network/Tasks/overviewIPsec.htm#nat). Example IP address: `10.0.3.3` Example hostname: `cpe.example.com` ' maxLength: 255 minLength: 1 type: string cpeLocalIdentifierType: description: 'The type of identifier for your CPE device. The value you provide here must correspond to the value for `cpeLocalIdentifier`. ' enum: - IP_ADDRESS - HOSTNAME type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object staticRoutes: description: 'Static routes to the CPE. If you provide this attribute, it replaces the entire current set of static routes. A static route''s CIDR must not be a multicast address or class E address. The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `10.0.1.0/24` Example: `2001:db8::/32` ' items: type: string maxLength: 10 minLength: 1 type: array uniqueItems: true UpdateDrgAttachmentDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string drgRouteTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table that is assigned to this attachment. The DRG route table manages traffic inside the DRG. You can''t remove a DRG route table from a DRG attachment, but you can reassign which DRG route table it uses. ' maxLength: 255 minLength: 1 type: string exportDrgRouteDistributionId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the export route distribution used to specify how routes in the assigned DRG route table are advertised out through the attachment. If this value is null, no routes are advertised through this attachment. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object networkDetails: $ref: '#/components/schemas/DrgAttachmentNetworkUpdateDetails' routeTableId: description: "This is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table that is used to route the traffic as it enters a VCN through this attachment.\n\nFor information about why you would associate a route table with a DRG attachment, see:\n\n * [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm)\n * [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)\n" maxLength: 255 minLength: 1 type: string UpdatePrivateIpDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostnameLabel: description: 'The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP''s fully qualified domain name (FQDN) (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `bminstance1` ' maxLength: 63 minLength: 1 type: string lifetime: description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to reassign the private IP to. The VNIC must be in the same subnet as the current VNIC. ' maxLength: 255 minLength: 1 type: string CreateLocalPeeringGatewayDetails: properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the local peering gateway (LPG). ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG will use. If you don''t specify a route table here, the LPG is created without an associated route table. The Networking service does NOT automatically associate the attached VCN''s default route table with the LPG. For information about why you would associate a route table with an LPG, see [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm). ' maxLength: 255 minLength: 1 type: string securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the LPG belongs to. maxLength: 255 minLength: 1 type: string required: - compartmentId - vcnId Subnet: description: 'A logical subdivision of a VCN. Each subnet consists of a contiguous range of IP addresses that do not overlap with other subnets in the VCN. Example: 172.16.1.0/24. For more information, see [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm) and [VCNs and Subnets](/iaas/Content/Network/Tasks/managingVCNs.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: availabilityDomain: description: 'The subnet''s availability domain. This attribute will be null if this is a regional subnet instead of an AD-specific subnet. Oracle recommends creating regional subnets. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string cidrBlock: description: 'The subnet''s CIDR block. Example: `10.0.1.0/24` ' maxLength: 32 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the subnet. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object dhcpOptionsId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options that the subnet uses. ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string dnsLabel: description: 'A DNS label for the subnet, used in conjunction with the VNIC''s hostname and VCN''s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed. The absence of this parameter means the Internet and VCN Resolver will not resolve hostnames of instances in this subnet. For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `subnet123` ' maxLength: 15 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The subnet's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string ipv4CidrBlocks: description: 'The list of all IPv4 CIDR blocks for the subnet that meets the following criteria: - Ipv4 CIDR blocks must be valid. - Multiple Ipv4 CIDR blocks must not overlap each other or the on-premises network CIDR block. - The number of prefixes must not exceed the limit of IPv4 prefixes allowed to a subnet. ' items: maxLength: 32 minLength: 1 type: string type: array uniqueItems: true ipv6CidrBlock: description: 'For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet''s private IP address space. The subnet size is always /64. IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123:1111::/64` ' maxLength: 45 minLength: 1 type: string ipv6CidrBlocks: description: 'The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet. ' items: maxLength: 45 minLength: 1 type: string type: array uniqueItems: true ipv6PublicCidrBlock: description: 'For an IPv6-enabled subnet, this is the IPv6 prefix for the subnet''s public IP address space. The subnet size is always /64. The left 48 bits are inherited from the `ipv6PublicCidrBlock` of the [Vcn](#/en/iaas/latest/Vcn/), and the remaining 16 bits are from the subnet''s `ipv6CidrBlock`. Example: `2001:0db8:0123:1111::/64` ' maxLength: 45 minLength: 1 type: string ipv6VirtualRouterIp: description: 'For an IPv6-enabled subnet, this is the IPv6 address of the virtual router. Example: `2001:0db8:0123:1111:89ab:cdef:1234:5678` ' maxLength: 45 minLength: 1 type: string lifecycleState: description: The subnet's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string prohibitPublicIpOnVnic: description: 'Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/)). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it''s a private subnet). Example: `true` ' type: boolean routeTableId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table that the subnet uses. maxLength: 255 minLength: 1 type: string securityListIds: description: 'The OCIDs of the security list or lists that the subnet uses. Remember that security lists are associated *with the subnet*, but the rules are applied to the individual VNICs in the subnet. ' items: maxLength: 255 maximum: 5 minLength: 1 minimum: 0 type: string type: array subnetDomainName: description: 'The subnet''s domain name, which consists of the subnet''s DNS label, the VCN''s DNS label, and the `oraclevcn.com` domain. For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `subnet123.vcn1.oraclevcn.com` ' maxLength: 253 minLength: 1 type: string timeCreated: description: 'The date and time the subnet was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the subnet is in. maxLength: 255 minLength: 1 type: string virtualRouterIp: description: 'The IP address of the virtual router. Example: `10.0.14.1` ' maxLength: 32 minLength: 1 type: string virtualRouterMac: description: 'The MAC address of the virtual router. Example: `00:00:00:00:00:01` ' maxLength: 32 minLength: 1 type: string required: - vcnId - id - compartmentId - cidrBlock - virtualRouterIp - routeTableId - virtualRouterMac - lifecycleState x-example: "{\n \"availabilityDomain\" : \"crmS:PHX-AD-1\",\n \"cidrBlock\" : \"10.0.2.0/24\",\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"dhcpOptionsId\" : \"ocid1.dhcpoptions.oc1.phx.<unique_ID>\",\n \"displayName\" : \"MySubnet\",\n \"id\" : \"ocid1.subnet.oc1.phx.<unique_ID>\",\n \"lifecycleState\" : \"AVAILABLE\",\n \"routeTableId\" : \"ocid1.routetable.oc1.phx.<unique_ID>\",\n \"securityListIds\" : [ \"ocid1.securitylist.oc1.phx.<unique_ID>\" ],\n \"timeCreated\" : \"2016-11-18T22:26:14.639Z\",\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\",\n \"virtualRouterIp\" : \"10.0.1.1\",\n \"virtualRouterMac\" : \"00:00:00:00:00:01\"\n}\n" ByoipAllocatedRangeSummary: description: A summary of CIDR block subranges that are currently allocated to an IP pool. properties: cidrBlock: description: The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. maxLength: 18 minLength: 9 type: string publicIpPoolId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IP pool containing the CIDR block. ' maxLength: 255 minLength: 1 type: string ChangeNetworkSecurityGroupCompartmentDetails: properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the network security group to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId NetworkingTopology: allOf: - $ref: '#/components/schemas/Topology' - discriminator: NETWORKING description: "Defines the representation of a virtual network topology for a region. \nSee [Network Visualizer Documentation](/iaas/Content/Network/Concepts/network_visualizer.htm) for more information, including\nconventions and pictures of symbols.\n" NetworkSecurityGroup: description: "A *network security group* (NSG) provides virtual firewall rules for a specific set of\n[VNICs](#/en/iaas/latest/Vnic/) in a VCN. Compare NSGs with [SecurityLists](#/en/iaas/latest/SecurityList/),\nwhich provide virtual firewall rules to all the VNICs in a *subnet*.\n\nA network security group consists of two items:\n\n * The set of [VNICs](#/en/iaas/latest/Vnic/) that all have the same security rule needs (for\n example, a group of Compute instances all running the same application)\n * A set of NSG [SecurityRules](#/en/iaas/latest/SecurityRule/) that apply to the VNICs in the group\n\nAfter creating an NSG, you can add VNICs and security rules to it. For example, when you create\nan instance, you can specify one or more NSGs to add the instance to (see\n[CreateVnicDetails](#/en/iaas/latest/datatypes/CreateVnicDetails)). Or you can add an existing\ninstance to an NSG with [UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic).\n\nTo add security rules to an NSG, see\n[AddNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/AddNetworkSecurityGroupSecurityRules).\n\nTo list the VNICs in an NSG, see\n[ListNetworkSecurityGroupVnics](#/en/iaas/latest/NetworkSecurityGroupVnic/ListNetworkSecurityGroupVnics).\n\nTo list the security rules in an NSG, see\n[ListNetworkSecurityGroupSecurityRules](#/en/iaas/latest/SecurityRule/ListNetworkSecurityGroupSecurityRules).\n\nFor more information about network security groups, see\n[Network Security Groups](/iaas/Content/Network/Concepts/networksecuritygroups.htm).\n\n**Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example,\nLinux iptables, Windows firewall). If there are issues with some type of access to an instance,\nmake sure all of the following are set correctly:\n\n * Any security rules in any NSGs the instance's VNIC belongs to\n * Any [SecurityLists](#/en/iaas/latest/SecurityList/) associated with the instance's subnet\n * The instance's OS firewall rules\n\nTo use any of the API operations, you must be authorized in an IAM policy. If you're not authorized,\ntalk to an administrator. If you're an administrator who needs to write policies to give users access, see\n[Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm).\n" properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment the network security group is in. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group. maxLength: 255 minLength: 1 type: string lifecycleState: description: The network security group's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string timeCreated: description: 'The date and time the network security group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group's VCN. maxLength: 255 minLength: 1 type: string required: - compartmentId - id - lifecycleState - timeCreated - vcnId ListIpInventoryDetails: description: 'Required input parameters for retrieving IP Inventory data within the specified compartments of a region. ' properties: addressTypeList: description: List of IP address types used. items: $ref: '#/components/schemas/AddressType' type: array compartmentList: description: List the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartments. items: maxLength: 255 minLength: 1 type: string type: array overlappingVcnsOnly: default: false description: List of overlapping VCNs. type: boolean overrideFilters: default: false description: List of selected filters. type: boolean paginationLimit: default: 10 description: 'Specifies the maximum number of results displayed per page for a paginated "List" call. For more information, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' format: int32 maximum: 50 minimum: 1 type: integer paginationOffset: default: 0 description: 'Most List operations paginate results. Results are paginated for the ListInstances operations. When you call a paginated List operation, the response indicates more pages of results by including the opc-next-page header. For more information, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' format: int32 maxLength: 4096 minLength: 1 type: integer regionList: description: Lists the selected regions. items: maxLength: 255 minLength: 1 type: string type: array resourceTypeList: description: List of VCN resource types. items: enum: - Resource type: string type: array searchKeyword: description: Filters the results for the specified string. maxLength: 255 minLength: 0 type: string sortBy: default: DISPLAYNAME description: "Provide the sort order (`sortOrder`) to sort the fields such as TIMECREATED in descending or descending order, and DISPLAYNAME in case sensitive. \n\n**Note:** For some \"List\" operations (for example, `ListInstances`), sort resources by an availability domain when the resources belong to a single availability domain. \nIf you sort the \"List\" operations without specifying\nan availability domain, the resources are grouped by availability domains and then sorted.\n" enum: - DISPLAYNAME - UTILIZATION - DNS_HOSTNAME - REGION type: string x-default-description: The default field to sort by varies by API. sortOrder: default: ASC description: 'Specifies the sort order to use. Select either ascending (`ASC`) or descending (`DESC`) order. The DISPLAYNAME sort order is case sensitive. ' enum: - ASC - DESC type: string x-default-description: The default sort order varies by API. utilization: description: The CIDR utilization of a VCN. format: float maximum: 100.0 minimum: 0.0 type: number required: - regionList - compartmentList Service: description: 'An object that represents one or multiple Oracle services that you can enable for a [ServiceGateway](#/en/iaas/latest/ServiceGateway/). In the User Guide topic [Access to Oracle Services: Service Gateway](/iaas/Content/Network/Tasks/servicegateway.htm), the term *service CIDR label* is used to refer to the string that represents the regional public IP address ranges of the Oracle service or services covered by a given `Service` object. That unique string is the value of the `Service` object''s `cidrBlock` attribute. ' properties: cidrBlock: description: 'A string that represents the regional public IP address ranges for the Oracle service or services covered by this `Service` object. Also known as the `Service` object''s *service CIDR label*. When you set up a route rule to route traffic to the service gateway, use this value as the rule''s destination. See [Route Table](#/en/iaas/latest/RouteTable/). Also, when you set up a security list rule to cover traffic with the service gateway, use the `cidrBlock` value as the rule''s destination (for an egress rule) or the source (for an ingress rule). See [Security List](#/en/iaas/latest/SecurityList/). Example: `oci-phx-objectstorage` ' maxLength: 255 minLength: 1 type: string description: description: 'Description of the Oracle service or services covered by this `Service` object. Example: `OCI PHX Object Storage` ' maxLength: 255 minLength: 1 type: string id: description: The `Service` object's [OCID](/iaas/Content/General/Concepts/identifiers.htm). maxLength: 255 minLength: 1 type: string name: description: 'Name of the `Service` object. This name can change and is not guaranteed to be unique. Example: `OCI PHX Object Storage` ' maxLength: 127 minLength: 1 type: string required: - id - name - cidrBlock - description DrgRouteRule: description: 'A DRG route rule is a mapping between a destination IP address range and a DRG attachment. The map is used to route matching packets. Traffic will be routed across the attachments using Equal-cost multi-path routing (ECMP) if there are multiple rules with identical destinations and none of the rules conflict. ' properties: attributes: additionalProperties: true description: 'Additional properties for the route, computed by the service. ' type: object destination: description: "Represents the range of IP addresses to match against when routing traffic.\n\nPotential values:\n * An IP address range (IPv4 or IPv6) in CIDR notation. For example: `192.168.1.0/24`\n or `2001:0db8:0123:45::/56`.\n * When you're setting up a security rule for traffic destined for a particular `Service` through\n a service gateway, this is the `cidrBlock` value associated with that [Service](#/en/iaas/20160918/Service/). For example: `oci-phx-objectstorage`.\n" maxLength: 255 minLength: 1 type: string destinationType: description: "The type of destination for the rule.\n\nAllowed values:\n\n * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.\n * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a\n particular `Service` through a service gateway).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK type: string id: description: 'The Oracle-assigned ID of the DRG route rule. ' maxLength: 255 minLength: 1 type: string isBlackhole: default: false description: 'Indicates that if the next hop attachment does not exist, so traffic for this route is discarded without notification. ' type: boolean isConflict: default: false description: 'Indicates that the route was not imported due to a conflict between route rules. ' type: boolean nextHopDrgAttachmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment responsible for reaching the network destination. A value of `BLACKHOLE` means traffic for this route is discarded without notification. ' maxLength: 255 minLength: 1 type: string routeProvenance: description: 'The earliest origin of a route. If a route is advertised to a DRG through an IPsec tunnel attachment, and is propagated to peered DRGs via RPC attachments, the route''s provenance in the peered DRGs remains `IPSEC_TUNNEL`, because that is the earliest origin. No routes with a provenance `IPSEC_TUNNEL` or `VIRTUAL_CIRCUIT` will be exported to IPsec tunnel or virtual circuit attachments, regardless of the attachment''s export distribution. ' enum: - STATIC - VCN - VIRTUAL_CIRCUIT - IPSEC_TUNNEL type: string routeType: description: 'You can specify static routes for the DRG route table using the API. The DRG learns dynamic routes from the DRG attachments using various routing protocols. ' enum: - STATIC - DYNAMIC type: string required: - destination - nextHopDrgAttachmentId - destinationType - id - routeProvenance UpdateCpeDetails: properties: cpeDeviceShapeId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device type. You can provide\na value if you want to generate CPE device configuration content for IPSec connections\nthat use this CPE. For a list of possible values, see\n[ListCpeDeviceShapes](#/en/iaas/latest/CpeDeviceShapeSummary/ListCpeDeviceShapes).\n\nFor more information about generating CPE device configuration content, see:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfig)\n" maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ChangeDhcpOptionsCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the set of DHCP options to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId RemoveSubnetIpv6CidrDetails: description: Details object for removing an IPv6 prefix from a subnet. properties: ipv6CidrBlock: description: 'This field is not required and should only be specified when removing an IPv6 prefix from a subnet''s IPv6 address space. See[IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123::/64` ' maxLength: 45 minLength: 1 type: string required: - ipv6CidrBlock BulkUpdateIpv6sItem: description: A secondary IPv6 object to update as part of a bulk update. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipv6Id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6 object. ' maxLength: 255 minLength: 1 type: string isInternetAccessAllowed: default: true description: 'Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the IPv6 uses its public IP address for internet communication. If `isInternetAccessAllowed` is set to `false`, the resulting `publicIpAddress` attribute for the `Ipv6` is null. Example: `true` ' type: boolean lifetime: default: EPHEMERAL description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string required: - ipv6Id ChangeVlanCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the VLAN to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId TunnelPhaseTwoDetails: description: IPsec tunnel detail information specific to phase two. properties: customAuthenticationAlgorithm: description: 'Phase two authentication algorithm proposed during tunnel negotiation. ' maxLength: 255 minLength: 1 type: string customEncryptionAlgorithm: description: 'The proposed custom phase two encryption algorithm. ' maxLength: 255 minLength: 1 type: string dhGroup: description: 'The proposed Diffie-Hellman group. ' maxLength: 255 minLength: 1 type: string isCustomPhaseTwoConfig: description: 'Indicates whether custom phase two configuration is enabled. If this option is not enabled, default settings are proposed. ' type: boolean isEspEstablished: description: Indicates that ESP phase two is established. type: boolean isPfsEnabled: description: Indicates that PFS (perfect forward secrecy) is enabled. type: boolean lifetime: description: The total configured lifetime of the IKE security association. format: int64 type: integer negotiatedAuthenticationAlgorithm: description: The negotiated phase two authentication algorithm. maxLength: 255 minLength: 1 type: string negotiatedDhGroup: description: The negotiated Diffie-Hellman group. maxLength: 255 minLength: 1 type: string negotiatedEncryptionAlgorithm: description: The negotiated encryption algorithm. maxLength: 255 minLength: 1 type: string remainingLifetime: description: The remaining lifetime before the key is refreshed. format: int64 type: integer remainingLifetimeLastRetrieved: description: 'The date and time the remaining lifetime was last retrieved, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: object BulkAddVirtualCircuitPublicPrefixesDetails: properties: publicPrefixes: description: The public IP prefixes (CIDRs) to add to the public virtual circuit. items: $ref: '#/components/schemas/CreateVirtualCircuitPublicPrefixDetails' maximum: 50 minimum: 0 type: array required: - publicPrefixes ChangeLocalPeeringGatewayCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the local peering gateway to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId CreatePublicIpDetails: properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the public IP. For ephemeral public IPs, you must set this to the private IP''s compartment [OCID](/iaas/Content/General/Concepts/identifiers.htm). ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object lifetime: description: 'Defines when the public IP is deleted and released back to the Oracle Cloud Infrastructure public IP pool. For more information, see [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). ' enum: - EPHEMERAL - RESERVED type: string privateIpId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP to assign the public IP to. Required for an ephemeral public IP because it must always be assigned to a private IP (specifically a *primary* private IP). Optional for a reserved public IP. If you don''t provide it, the public IP is created but not assigned to a private IP. You can later assign the public IP with [UpdatePublicIp](#/en/iaas/latest/PublicIp/UpdatePublicIp). ' maxLength: 255 minLength: 1 type: string publicIpPoolId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool. maxLength: 255 minLength: 1 type: string required: - compartmentId - lifetime BulkDetachIpv6sItem: description: A secondary IPv6 object to detach as part of a bulk detach operation. properties: ipv6Id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secondary IPv6. ' maxLength: 255 minLength: 1 type: string required: - ipv6Id DrgAttachment: description: 'A DRG attachment serves as a link between a DRG and a network resource. A DRG can be attached to a VCN, IPSec tunnel, remote peering connection, or virtual circuit. For more information, see [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the DRG attachment. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string drgId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. maxLength: 255 minLength: 1 type: string drgRouteTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table that is assigned to this attachment. The DRG route table manages traffic inside the DRG. ' maxLength: 255 minLength: 1 type: string exportDrgRouteDistributionId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the export route distribution used to specify how routes in the assigned DRG route table are advertised to the attachment. If this value is null, no routes are advertised through this attachment. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The DRG attachment's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string isCrossTenancy: description: 'Indicates whether the DRG attachment and attached network live in a different tenancy than the DRG. Example: `false` ' type: boolean lifecycleState: description: The DRG attachment's current state. enum: - ATTACHING - ATTACHED - DETACHING - DETACHED type: string networkDetails: $ref: '#/components/schemas/DrgAttachmentNetworkDetails' routeTableId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the DRG attachment is using.\n\nFor information about why you would associate a route table with a DRG attachment, see:\n\n * [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm)\n * [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)\n\nThis field is deprecated. Instead, use the `networkDetails` field to view the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the attached resource.\n" maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the DRG attachment was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. This field is deprecated. Instead, use the `networkDetails` field to view the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the attached resource. ' maxLength: 255 minLength: 1 type: string required: - id - compartmentId - drgId - lifecycleState DefaultDrgRouteTables: description: 'The default DRG route table for this DRG. Each network type has a default DRG route table. You can update a network type to use a different DRG route table, but each network type must have a default DRG route table. You cannot delete a default DRG route table. ' properties: ipsecTunnel: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table assigned to DRG attachments of type IPSEC_TUNNEL on creation. ' maxLength: 255 minLength: 1 type: string remotePeeringConnection: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments of type REMOTE_PEERING_CONNECTION on creation. ' maxLength: 255 minLength: 1 type: string vcn: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments of type VCN on creation. ' maxLength: 255 minLength: 1 type: string virtualCircuit: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the default DRG route table to be assigned to DRG attachments of type VIRTUAL_CIRCUIT on creation. ' maxLength: 255 minLength: 1 type: string CreateDrgRouteTableDetails: description: 'Details used in a request to create a DRG route table. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string drgId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG route table belongs to. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object importDrgRouteDistributionId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements through referenced attachments are inserted into the DRG route table. ' maxLength: 255 minLength: 1 type: string isEcmpEnabled: default: false description: 'If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to your on-premises networks, enable ECMP on the DRG route table. ' type: boolean required: - drgId ByoasnByoipRange: description: Information about 'ByoipRange' that has `byoasn` as origin. properties: asPathPrependLength: default: 1 description: The as path prepend length. minimum: 1 type: integer byoipRangeId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. maxLength: 255 minLength: 1 type: string cidrBlock: description: The BYOIP CIDR block range or subrange allocated to an IP pool. This could be all or part of a BYOIP CIDR block. maxLength: 18 minLength: 9 type: string ipv6CidrBlock: description: 'The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size. ' maxLength: 45 minLength: 1 type: string required: - byoipRangeId type: object MacsecKey: description: An object defining the Secrets-in-Vault OCIDs representing the MACsec key. properties: connectivityAssociationKeySecretId: description: Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. maxLength: 255 minLength: 1 type: string connectivityAssociationKeySecretVersion: description: The secret version of the `connectivityAssociationKey` secret in Vault. format: int64 maximum: 65535 minimum: 1 type: integer connectivityAssociationNameSecretId: description: Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. maxLength: 255 minLength: 1 type: string connectivityAssociationNameSecretVersion: description: The secret version of the connectivity association name secret in Vault. format: int64 maximum: 65535 minimum: 1 type: integer required: - connectivityAssociationNameSecretId - connectivityAssociationKeySecretId IPSecConnectionTunnel: description: 'Information about a single IPSec tunnel in an IPSec connection. This object does not include the tunnel''s shared secret (pre-shared key), which is found in the [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/) object. ' properties: associatedVirtualCircuits: description: 'The list of virtual circuit [OCID](/iaas/Content/General/Concepts/identifiers.htm)s over which your network can reach this tunnel. ' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true bgpSessionInfo: $ref: '#/components/schemas/BgpSessionInfo' compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the tunnel. ' maxLength: 255 minLength: 1 type: string cpeIp: description: 'The IP address of the CPE device''s VPN headend. Example: `203.0.113.22` ' maxLength: 46 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string dpdMode: description: 'Dead peer detection (DPD) mode set on the Oracle side of the connection. This mode sets whether Oracle can only respond to a request from the CPE device to start DPD, or both respond to and initiate requests. ' enum: - INITIATE_AND_RESPOND - RESPOND_ONLY type: string dpdTimeoutInSec: description: DPD timeout in seconds. type: integer encryptionDomainConfig: $ref: '#/components/schemas/EncryptionDomainConfig' id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel. maxLength: 255 minLength: 1 type: string lifecycleState: description: The tunnel's lifecycle state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string natTranslationEnabled: description: 'By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, and when it detects that the port used to forward packets has changed (most likely because a NAT device is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T even if it senses there may be a NAT device in use. . ' enum: - ENABLED - DISABLED - AUTO type: string oracleCanInitiate: description: 'Indicates whether Oracle can only respond to a request to start an IPSec tunnel from the CPE device, or both respond to and initiate requests. ' enum: - INITIATOR_OR_RESPONDER - RESPONDER_ONLY type: string phaseOneDetails: $ref: '#/components/schemas/TunnelPhaseOneDetails' phaseTwoDetails: $ref: '#/components/schemas/TunnelPhaseTwoDetails' routing: description: 'The type of routing used for this tunnel (BGP dynamic routing, static routing, or policy-based routing). ' enum: - BGP - STATIC - POLICY type: string status: description: The status of the tunnel based on IPSec protocol characteristics. enum: - UP - DOWN - DOWN_FOR_MAINTENANCE - PARTIAL_UP type: string timeCreated: description: 'The date and time the IPSec tunnel was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStatusUpdated: description: 'When the status of the IPSec tunnel last changed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vpnIp: description: 'The IP address of the Oracle VPN headend for the connection. Example: `203.0.113.21` ' maxLength: 46 minLength: 1 type: string required: - compartmentId - id - lifecycleState UpdateVlanDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object nsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN will belong to these NSGs. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the VLAN will use. ' maxLength: 255 minLength: 1 type: string PhaseOneConfigDetails: description: Configuration details for IKE phase one (ISAKMP) configuration parameters. properties: authenticationAlgorithm: description: 'The custom authentication algorithm proposed during phase one tunnel negotiation. ' enum: - SHA2_384 - SHA2_256 - SHA1_96 type: string diffieHelmanGroup: description: 'The custom Diffie-Hellman group proposed during phase one tunnel negotiation. ' enum: - GROUP2 - GROUP5 - GROUP14 - GROUP19 - GROUP20 - GROUP24 type: string encryptionAlgorithm: description: 'The custom encryption algorithm proposed during phase one tunnel negotiation. ' enum: - AES_256_CBC - AES_192_CBC - AES_128_CBC type: string isCustomPhaseOneConfig: description: Indicates whether custom configuration is enabled for phase one options. type: boolean lifetimeInSeconds: description: 'Internet key association (IKE) session key lifetime in seconds for IPSec phase one. The default is 28800 which is equivalent to 8 hours. ' type: integer type: object CrossConnectPortSpeedShape: description: 'An individual port speed level for cross-connects. ' properties: name: description: 'The name of the port speed shape. Example: `10 Gbps` ' maxLength: 255 minLength: 1 type: string portSpeedInGbps: description: 'The port speed in Gbps. Example: `10` ' maxLength: 255 minLength: 1 type: integer required: - name - portSpeedInGbps MacsecProperties: description: Properties used for MACsec (if capable). properties: encryptionCipher: description: Type of encryption cipher suite to use for the MACsec connection. enum: - AES128_GCM - AES128_GCM_XPN - AES256_GCM - AES256_GCM_XPN type: string x-obmcs-top-level-enum: '#/definitions/MacsecEncryptionCipher' isUnprotectedTrafficAllowed: default: false description: Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. type: boolean primaryKey: $ref: '#/components/schemas/MacsecKey' state: description: Indicates whether or not MACsec is enabled. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/MacsecState' required: - state CaptureFilter: description: "A capture filter contains a set of *[rules](#/en/iaas/latest/datatypes/CaptureFilterRuleDetails)* governing what traffic is \nmirrored for a *[VTAP](#/en/iaas/latest/Vtap)* or captured for a *[VCN Flow Log](/iaas/Content/Network/Concepts/vcn-flow-logs.htm)*.\nThe capture filter is created with no rules defined, and it must have at least one rule to mirror traffic for the VTAP or collect VCN flow logs.\n" properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string filterType: description: Indicates which service will use this capture filter enum: - VTAP type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The capture filter''s Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The capture filter's current administrative state. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED type: string timeCreated: description: 'The date and time the capture filter was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2021-08-25T21:10:29.600Z` ' format: date-time type: string vtapCaptureFilterRules: description: 'The set of rules governing what traffic a VTAP mirrors. ' items: $ref: '#/components/schemas/VtapCaptureFilterRuleDetails' type: array required: - compartmentId - id - lifecycleState CrossConnectMapping: description: 'For use with Oracle Cloud Infrastructure FastConnect. Each [VirtualCircuit](#/en/iaas/latest/VirtualCircuit/) runs on one or more cross-connects or cross-connect groups. A `CrossConnectMapping` contains the properties for an individual cross-connect or cross-connect group associated with a given virtual circuit. The mapping includes information about the cross-connect or cross-connect group, the VLAN, and the BGP peering session. If you''re a customer who is colocated with Oracle, that means you own both the virtual circuit and the physical connection it runs on (cross-connect or cross-connect group), so you specify all the information in the mapping. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. If you''re a provider, then you own the physical connection that the customer''s virtual circuit runs on, so you contribute information about the cross-connect or cross-connect group and VLAN. Who specifies the BGP peering information in the case of customer connection via provider? If the BGP session goes from Oracle to the provider''s edge router, then the provider also specifies the BGP peering information. If the BGP session instead goes from Oracle to the customer''s edge router, then the customer specifies the BGP peering information. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. Every `CrossConnectMapping` must have BGP IPv4 peering addresses. BGP IPv6 peering addresses are optional. If BGP IPv6 addresses are provided, the customer can exchange IPv6 routes with Oracle. ' properties: bgpMd5AuthKey: description: 'The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don''t use BGP MD5 authentication. ' maxLength: 255 minLength: 1 type: string crossConnectOrCrossConnectGroupId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). ' maxLength: 255 minLength: 1 type: string customerBgpPeeringIp: description: 'The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer''s edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider''s edge router. Must use a subnet mask from /28 to /31. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. Example: `10.0.0.18/31` ' maxLength: 46 minLength: 7 type: string customerBgpPeeringIpv6: description: 'The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer''s edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider''s edge router. Only subnet masks from /64 up to /127 are allowed. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:db8::1/64` ' maxLength: 50 minLength: 4 type: string oracleBgpPeeringIp: description: 'The IPv4 address for Oracle''s end of the BGP session. Must use a subnet mask from /28 to /31. If the session goes from Oracle to a customer''s edge router, the customer specifies this information. If the session goes from Oracle to a provider''s edge router, the provider specifies this. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. Example: `10.0.0.19/31` ' maxLength: 46 minLength: 7 type: string oracleBgpPeeringIpv6: description: 'The IPv6 address for Oracle''s end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer''s edge router, the customer specifies this information. If the session goes from Oracle to a provider''s edge router, the provider specifies this. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. Note that IPv6 addressing is currently supported only in certain regions. See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:db8::2/64` ' maxLength: 50 minLength: 4 type: string vlan: description: 'The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: `200` ' maximum: 16777216 minimum: 100 type: integer ChangeVtapCompartmentDetails: description: These configuration details are used in the move operation when changing the compartment containing a virtual test access point (VTAP). properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the VTAP move. ' maxLength: 255 minLength: 1 type: string required: - compartmentId ChangeCaptureFilterCompartmentDetails: description: 'These configuration details are used in the move operation when changing the compartment containing a capture filter. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the VTAP capture filter move. ' maxLength: 255 minLength: 1 type: string required: - compartmentId CrossConnect: description: 'For use with Oracle Cloud Infrastructure FastConnect. A cross-connect represents a physical connection between an existing network and Oracle. Customers who are colocated with Oracle in a FastConnect location create and use cross-connects. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). Oracle recommends you create each cross-connect in a [CrossConnectGroup](#/en/iaas/latest/CrossConnectGroup) so you can use link aggregation with the connection. **Note:** If you''re a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer''s (with `CrossConnect` and `CrossConnectGroup` objects, and so on). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group. maxLength: 255 minLength: 1 type: string crossConnectGroupId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group this cross-connect belongs to (if any). ' maxLength: 255 minLength: 1 type: string customerReferenceName: description: 'A reference name or identifier for the physical fiber connection that this cross-connect uses. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The cross-connect's Oracle ID (OCID). maxLength: 255 minLength: 1 type: string interfaceName: description: 'The name of the FastConnect interface where this cross-connect is installed. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The cross-connect's current state. enum: - PENDING_CUSTOMER - PROVISIONING - PROVISIONED - INACTIVE - TERMINATING - TERMINATED type: string locationName: description: 'The name of the FastConnect location where this cross-connect is installed. ' maxLength: 255 minLength: 1 type: string macsecProperties: $ref: '#/components/schemas/MacsecProperties' ociLogicalDeviceName: description: 'The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection. ' maxLength: 255 minLength: 1 type: string ociPhysicalDeviceName: description: 'The FastConnect device that terminates the physical connection. ' maxLength: 255 minLength: 1 type: string portName: description: A string identifying the meet-me room port for this cross-connect. maxLength: 255 minLength: 1 type: string portSpeedShapeName: description: 'The port speed for this cross-connect. Example: `10 Gbps` ' type: string timeCreated: description: 'The date and time the cross-connect was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string ChangeByoipRangeCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the BYOIP CIDR block move. ' maxLength: 255 minLength: 1 type: string required: - compartmentId CreateIPSecTunnelEncryptionDomainDetails: description: 'Request to enable a multi-encryption domain policy on the IPSec tunnel. There can''t be more than 50 security associations in use at one time. See [Encryption domain for policy-based tunnels](/iaas/Content/Network/Tasks/ipsecencryptiondomains.htm#spi_policy_based_tunnel) for more. ' properties: cpeTrafficSelector: description: Lists IPv4 or IPv6-enabled subnets in your on-premises network. items: type: string minLength: 1 type: array uniqueItems: true oracleTrafficSelector: description: Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy. items: type: string minLength: 1 type: array uniqueItems: true CreateVtapDetails: description: These details are included in a request to create a virtual test access point (VTAP). properties: captureFilterId: description: 'The capture filter''s Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). ' maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string encapsulationProtocol: description: 'Defines an encapsulation header type for the VTAP''s mirrored traffic. ' enum: - VXLAN type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isVtapEnabled: default: false description: 'Used to start or stop a `Vtap` resource. * `TRUE` directs the VTAP to start mirroring traffic. * `FALSE` (Default) directs the VTAP to stop mirroring traffic. ' type: boolean maxPacketSize: description: The maximum size of the packets to be included in the filter. format: int32 type: integer sourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. ' maxLength: 255 minLength: 1 type: string sourcePrivateEndpointIp: description: 'The IP Address of the source private endpoint. ' maxLength: 46 minLength: 1 type: string sourcePrivateEndpointSubnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. ' maxLength: 255 minLength: 1 type: string sourceType: description: 'The source type for the VTAP. ' enum: - VNIC - SUBNET - LOAD_BALANCER - DB_SYSTEM - EXADATA_VM_CLUSTER - AUTONOMOUS_DATA_WAREHOUSE type: string targetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. ' maxLength: 255 minLength: 1 type: string targetIp: description: 'The IP address of the destination resource where mirrored packets are sent. ' maxLength: 46 minLength: 1 type: string targetType: description: 'The target type for the VTAP. ' enum: - VNIC - NETWORK_LOAD_BALANCER - IP_ADDRESS type: string trafficMode: default: DEFAULT description: Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT enum: - DEFAULT - PRIORITY type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource. maxLength: 255 minLength: 1 type: string vxlanNetworkIdentifier: description: 'The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. ' format: int64 type: integer required: - compartmentId - vcnId - sourceId - captureFilterId LetterOfAuthority: description: 'The Letter of Authority for the cross-connect. You must submit this letter when requesting cabling for the cross-connect at the FastConnect location. ' properties: authorizedEntityName: description: The name of the entity authorized by this Letter of Authority. maxLength: 255 minLength: 1 type: string circuitType: description: The type of cross-connect fiber, termination, and optical specification. enum: - Single_mode_LC - Single_mode_SC type: string crossConnectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect. maxLength: 255 minLength: 1 type: string facilityLocation: description: The address of the FastConnect location. maxLength: 255 minLength: 1 type: string portName: description: The meet-me room port for this cross-connect. maxLength: 255 minLength: 1 type: string timeExpires: description: 'The date and time when the Letter of Authority expires, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). ' format: date-time type: string timeIssued: description: 'The date and time the Letter of Authority was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string ByoipRangeSummary: description: Information about a `ByoipRange` resource. properties: byoipRangeVcnIpv6Allocations: description: 'A list of `ByoipRangeVcnIpv6AllocationSummary` objects. ' items: $ref: '#/components/schemas/ByoipRangeVcnIpv6AllocationSummary' type: array cidrBlock: description: The public IPv4 address range you are importing to the Oracle cloud. maxLength: 18 minLength: 9 type: string compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `ByoipRange` resource. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource. maxLength: 255 minLength: 1 type: string ipv6CidrBlock: description: 'The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size. ' maxLength: 45 minLength: 1 type: string lifecycleDetails: description: The Byoip Range's current lifeCycle substate. type: string x-obmcs-enumref: '#/definitions/ByoipRange/lifecycleDetails' lifecycleState: description: The `ByoipRange` resource's current state. type: string x-obmcs-enumref: '#/definitions/ByoipRange/lifecycleState' timeCreated: description: 'The date and time the `ByoipRange` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string TunnelCpeDeviceConfig: description: "The set of CPE configuration answers for the tunnel, which the customer provides in\n[UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig).\nThe answers correlate to the questions that are specific to the CPE device type (see the\n`parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)).\n\nSee these related operations:\n\n * [GetTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfig)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n" properties: tunnelCpeDeviceConfigParameter: items: $ref: '#/components/schemas/CpeDeviceConfigAnswer' type: array ServiceGateway: description: 'Represents a router that lets your VCN privately access specific Oracle services such as Object Storage without exposing the VCN to the public internet. Traffic leaving the VCN and destined for a supported Oracle service (use the [ListServices](#/en/iaas/latest/Service/ListServices) operation to find available service CIDR labels) is routed through the service gateway and does not traverse the internet. The instances in the VCN do not need to have public IP addresses nor be in a public subnet. The VCN does not need an internet gateway for this traffic. For more information, see [Access to Oracle Services: Service Gateway](/iaas/Content/Network/Tasks/servicegateway.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: blockTraffic: default: false description: 'Whether the service gateway blocks all traffic through it. The default is `false`. When this is `true`, traffic is not routed to any services, regardless of route rules. Example: `true` ' type: boolean compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the service gateway. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service gateway. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The service gateway's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway is using. For information about why you would associate a route table with a service gateway, see [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm). ' maxLength: 255 minLength: 1 type: string services: description: 'List of the [Service](#/en/iaas/latest/Service/) objects enabled for this service gateway. The list can be empty. You can enable a particular `Service` by using [AttachServiceId](#/en/iaas/latest/ServiceGateway/AttachServiceId) or [UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway). ' items: $ref: '#/components/schemas/ServiceIdResponseDetails' type: array timeCreated: description: 'The date and time the service gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the service gateway belongs to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - id - lifecycleState - vcnId - blockTraffic - services AddressType: description: Address type of the CIDR/IP within a VCN or subnet enum: - Private_IPv4 - Oracle_Allocated_Public_IPv4 - BYOIP_IPv4 - ULA_IPv6 - Oracle_Allocated_GUA_IPv6 - BYOIP_IPv6 type: string CrossConnectLocation: description: An individual FastConnect location. properties: description: description: A description of the location. maxLength: 255 minLength: 1 type: string name: description: 'The name of the location. Example: `CyrusOne, Chandler, AZ` ' maxLength: 255 minLength: 1 type: string required: - name - description UpdateDhcpDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object options: items: $ref: '#/components/schemas/DhcpOption' type: array uniqueItems: true ChangeRemotePeeringConnectionCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the remote peering connection to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId UpdateDrgRouteRuleDetails: description: 'Details used to update a route rule in the DRG route table. ' properties: destination: description: "The range of IP addresses used for matching when routing traffic.\n\nPotential values:\n * IP address range in CIDR notation. Can be an IPv4 CIDR block or IPv6 prefix. For example: `192.168.1.0/24`\n or `2001:0db8:0123:45::/56`.\n" maxLength: 255 minLength: 1 type: string destinationType: description: "Type of destination for the rule.\nAllowed values:\n * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.\n" enum: - CIDR_BLOCK type: string id: description: 'The Oracle-assigned ID of each DRG route rule to update. ' maxLength: 255 minLength: 1 type: string nextHopDrgAttachmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment. The next hop DRG attachment is responsible for reaching the network destination. ' maxLength: 255 minLength: 1 type: string required: - id UpdateTunnelCpeDeviceConfigDetails: properties: tunnelCpeDeviceConfig: description: 'The set of configuration answers for a CPE device. ' items: $ref: '#/components/schemas/CpeDeviceConfigAnswer' type: array DrgAttachmentNetworkDetails: discriminator: propertyName: type properties: id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG. ' maxLength: 255 minLength: 1 type: string type: enum: - VCN - IPSEC_TUNNEL - VIRTUAL_CIRCUIT - REMOTE_PEERING_CONNECTION type: string required: - type GetIpInventoryVcnOverlapDetails: description: Lists the compartment to find VCN overlap. properties: compartmentList: description: The list of [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartments. items: maxLength: 255 minLength: 1 type: string type: array regionList: description: Lists the selected regions. items: maxLength: 255 minLength: 1 type: string type: array required: - regionList - compartmentList RemoveVcnIpv6CidrDetails: description: 'Details used when removing ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or BYOIPv6 prefix. You can only remove one of these per request. ' properties: ipv6CidrBlock: description: 'This field is not required and should only be specified when removing ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or BYOIPv6 prefix from a VCN''s IPv6 address space. See[IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123::/56` ' maxLength: 45 minLength: 1 type: string CreateRemotePeeringConnectionDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the RPC. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string drgId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the RPC belongs to. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId - drgId InventorySubnetSummary: description: 'Lists subnet and its associated resources. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string dnsDomainName: description: DNS domain name of the subnet. maxLength: 255 minLength: 1 type: string inventoryResourceSummary: description: 'Lists the `ResourceCollection` object. ' items: $ref: '#/components/schemas/InventoryResourceSummary' type: array inventorySubnetCidrCollection: description: 'Lists CIDRs and utilization within the subnet. ' items: $ref: '#/components/schemas/InventorySubnetCidrBlockSummary' type: array region: description: Region name of the subnet. maxLength: 255 minLength: 1 type: string resourceType: description: Resource types of the subnet. enum: - Subnet type: string subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet. maxLength: 255 minLength: 1 type: string subnetName: description: Name of the subnet within a VCN. maxLength: 255 minLength: 1 type: string RemovePublicIpPoolCapacityDetails: description: The information needed to remove capacity from a public IP pool. properties: cidrBlock: description: 'The CIDR block to remove from the public IP pool. Example: `10.0.1.0/24` ' maxLength: 18 minLength: 9 type: string required: - cidrBlock IpInventoryCollection: description: The results returned by a `ListIpInventory` operation. properties: compartmentsPerTenant: description: 'The number of compartments per compartments per tenant. ' format: int64 type: integer count: description: Species the count for the number of results for the response. format: int32 type: integer inventoryVcnCollection: description: 'Lists `IpInventoryVcnSummary` objects. ' items: $ref: '#/components/schemas/InventoryVcnSummary' type: array lastUpdatedTimestamp: description: 'The timestamp of the latest update from the database in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string message: description: 'Indicates the status of the data. ' maxLength: 255 minLength: 1 type: string BulkUpdatePrivateIpsDetails: description: Details used for a secondary IPv4 address bulk update. properties: bulkUpdatePrivateIpItem: description: 'A secondary IPv4 address to update. ' items: $ref: '#/components/schemas/BulkUpdatePrivateIpItem' maxItems: 16 minItems: 1 type: array vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to reassign the private IPs to. The VNIC and private IPs must be in the same subnet. ' maxLength: 255 minLength: 1 type: string required: - bulkUpdatePrivateIpItem UpdateNatGatewayDetails: properties: blockTraffic: default: false description: 'Whether the NAT gateway blocks traffic through it. The default is `false`. Example: `true` ' type: boolean definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. If you don''t specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN''s default route table with the NAT gateway. ' maxLength: 255 minLength: 1 type: string DrgRouteTable: description: 'All routing inside the DRG is driven by the contents of DRG route tables. DRG route tables contain rules which route packets to a particular network destination, represented as a DRG attachment. The routing decision for a packet entering a DRG is determined by the rules in the DRG route table assigned to the attachment-of-entry. Each DRG attachment can inject routes in any DRG route table, provided there is a statement corresponding to the attachment in the route table''s `importDrgRouteDistribution`. You can also insert static routes into the DRG route tables. The DRG route table is always in the same compartment as the DRG. There must always be a default DRG route table for each attachment type. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment the DRG is in. The DRG route table is always in the same compartment as the DRG. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string drgId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG that contains this route table. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table. ' maxLength: 255 minLength: 1 type: string importDrgRouteDistributionId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements from referenced attachments are inserted into the DRG route table. ' maxLength: 255 minLength: 1 type: string isEcmpEnabled: description: 'If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to your on-premises network, enable ECMP on the DRG route table to which these attachments import routes. ' type: boolean lifecycleState: description: The DRG route table's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string timeCreated: description: 'The date and time the DRG route table was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - drgId - id - timeCreated - compartmentId - lifecycleState - isEcmpEnabled x-example: "{\n \"drgId\" : \"ocid1.drg.oc1..<unique_ID>\",\n \"id\" : \"ocid1.drgroutetable.oc1..<unique_ID>\"\n \"compartmentId\": \"ocid1.compartment.oc1..<unique_ID>\",\n \"lifecycleState\": \"AVAILABLE\",\n \"timeCreated\" : \"2016-12-16T22:43:25.588Z\"\n}\n" CrossConnectStatus: description: The status of the cross-connect. properties: crossConnectId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect. maxLength: 255 minLength: 1 type: string encryptionStatus: description: 'Encryption status of this cross connect. Possible values: * **UP:** Traffic is encrypted over this cross-connect * **DOWN:** Traffic is not encrypted over this cross-connect * **CIPHER_MISMATCH:** The MACsec encryption cipher doesn''t match the cipher on the CPE * **CKN_MISMATCH:** The MACsec Connectivity association Key Name (CKN) doesn''t match the CKN on the CPE * **CAK_MISMATCH:** The MACsec Connectivity Association Key (CAK) doesn''t match the CAK on the CPE ' enum: - UP - DOWN - CIPHER_MISMATCH - CKN_MISMATCH - CAK_MISMATCH type: string interfaceState: description: Indicates whether Oracle's side of the interface is up or down. enum: - UP - DOWN type: string lightLevelIndBm: description: 'The light level of the cross-connect (in dBm). Example: `14.0` ' format: float maximum: 50.0 minimum: -50.0 type: number lightLevelIndicator: description: "Status indicator corresponding to the light level.\n\n * **NO_LIGHT:** No measurable light\n * **LOW_WARN:** There's measurable light but it's too low\n * **HIGH_WARN:** Light level is too high\n * **BAD:** There's measurable light but the signal-to-noise ratio is bad\n * **GOOD:** Good light level\n" enum: - NO_LIGHT - LOW_WARN - HIGH_WARN - BAD - GOOD type: string lightLevelsInDBm: description: 'The light levels of the cross-connect (in dBm). Example: `[14.0, -14.0, 2.1, -10.1]` ' items: format: float maximum: 50.0 minimum: -50.0 type: number type: array required: - crossConnectId ChangeByoasnCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the BYOASN resource move. ' maxLength: 255 minLength: 1 type: string required: - compartmentId RouteRule: description: 'A mapping between a destination IP address range and a virtual device to route matching packets to (a target). ' properties: cidrBlock: description: 'Deprecated. Instead use `destination` and `destinationType`. Requests that include both `cidrBlock` and `destination` will be rejected. A destination IP address range in CIDR notation. Matching packets will be routed to the indicated network entity (the target). Cannot be an IPv6 prefix. Example: `0.0.0.0/0` ' maxLength: 18 minLength: 9 type: string description: description: 'An optional description of your choice for the rule. ' maxLength: 255 minLength: 1 type: string destination: description: "Conceptually, this is the range of IP addresses used for matching when routing\ntraffic. Required if you provide a `destinationType`.\n\nAllowed values:\n\n * IP address range in CIDR notation. Can be an IPv4 CIDR block or IPv6 prefix. For example: `192.168.1.0/24`\n or `2001:0db8:0123:45::/56`. If you set this to an IPv6 prefix, the route rule's target\n can only be a DRG or internet gateway.\n IPv6 addressing is supported for all commercial and government regions.\n See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm).\n\n * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're\n setting up a route rule for traffic destined for a particular `Service` through\n a service gateway. For example: `oci-phx-objectstorage`.\n" maxLength: 255 minLength: 1 type: string destinationType: default: CIDR_BLOCK description: "Type of destination for the rule. Required if you provide a `destination`.\n\n * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.\n\n * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a\n particular `Service` through a service gateway).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK type: string networkEntityId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the route rule''s target. For information about the type of targets you can specify, see [Route Tables](/iaas/Content/Network/Tasks/managingroutetables.htm). ' maxLength: 255 minLength: 1 type: string routeType: description: 'A route rule can be STATIC if manually added to the route table, LOCAL if added by OCI to the route table. ' enum: - STATIC - LOCAL type: string required: - networkEntityId CreateSubnetDetails: properties: availabilityDomain: description: 'Controls whether the subnet is regional or specific to an availability domain. Oracle recommends creating regional subnets because they''re more flexible and make it easier to implement failover across availability domains. Originally, AD-specific subnets were the only kind available to use. To create a regional subnet, omit this attribute. Then any resources later created in this subnet (such as a Compute instance) can be created in any availability domain in the region. To instead create an AD-specific subnet, set this attribute to the availability domain you want this subnet to be in. Then any resources later created in this subnet can only be created in that availability domain. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string cidrBlock: description: 'The CIDR IP address range of the subnet. The CIDR must maintain the following rules - a. The CIDR block is valid and correctly formatted. b. The new range is within one of the parent VCN ranges. Example: `10.0.1.0/24` ' maxLength: 32 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the subnet. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object dhcpOptionsId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options the subnet will use. If you don''t provide a value, the subnet uses the VCN''s default set of DHCP options. ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string dnsLabel: description: 'A DNS label for the subnet, used in conjunction with the VNIC''s hostname and VCN''s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter and is unique within the VCN. The value cannot be changed. This value must be set if you want to use the Internet and VCN Resolver to resolve the hostnames of instances in the subnet. It can only be set if the VCN itself was created with a DNS label. For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `subnet123` ' maxLength: 15 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipv4CidrBlocks: description: 'The list of all IPv4 CIDR blocks for the subnet that meets the following criteria: - Ipv4 CIDR blocks must be valid. - Multiple Ipv4 CIDR blocks must not overlap each other or the on-premises network CIDR block. - The number of prefixes must not exceed the limit of IPv4 prefixes allowed to a subnet. ' items: maxLength: 32 minLength: 1 type: string type: array uniqueItems: true x-default-description: 'null' ipv6CidrBlock: description: 'Use this to enable IPv6 addressing for this subnet. The VCN must be enabled for IPv6. You can''t change this subnet characteristic later. All subnets are /64 in size. The subnet portion of the IPv6 address is the fourth hextet from the left (1111 in the following example). For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123:1111::/64` ' maxLength: 45 minLength: 1 type: string ipv6CidrBlocks: description: 'The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefixes, BYOIPv6 prefixes) for the subnet that meets the following criteria: - The prefixes must be valid. - Multiple prefixes must not overlap each other or the on-premises network prefix. - The number of prefixes must not exceed the limit of IPv6 prefixes allowed to a subnet. ' items: maxLength: 45 minLength: 1 type: string type: array uniqueItems: true x-default-description: 'null' prohibitPublicIpOnVnic: description: 'Whether VNICs within this subnet can have public IP addresses. Defaults to false, which means VNICs created in this subnet will automatically be assigned public IP addresses unless specified otherwise during instance launch or VNIC creation (with the `assignPublicIp` flag in [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/)). If `prohibitPublicIpOnVnic` is set to true, VNICs created in this subnet cannot have public IP addresses (that is, it''s a private subnet). For IPv6, if `prohibitPublicIpOnVnic` is set to `true`, internet access is not allowed for any IPv6s assigned to VNICs in the subnet. Example: `true` ' type: boolean routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the subnet will use. If you don''t provide a value, the subnet uses the VCN''s default route table. ' maxLength: 255 minLength: 1 type: string securityListIds: description: 'The OCIDs of the security list or lists the subnet will use. If you don''t provide a value, the subnet uses the VCN''s default security list. Remember that security lists are associated *with the subnet*, but the rules are applied to the individual VNICs in the subnet. ' items: maxLength: 255 maximum: 5 minLength: 1 minimum: 0 type: string type: array vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN to contain the subnet. maxLength: 255 minLength: 1 type: string required: - compartmentId - vcnId CreateDrgAttachmentDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string drgId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. maxLength: 255 minLength: 1 type: string drgRouteTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table that is assigned to this attachment. The DRG route table manages traffic inside the DRG. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object networkDetails: $ref: '#/components/schemas/DrgAttachmentNetworkCreateDetails' routeTableId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the DRG attachment.\n\nIf you don't specify a route table here, the DRG attachment is created without an associated route\ntable. The Networking service does NOT automatically associate the attached VCN's default route table\nwith the DRG attachment.\nFor information about why you would associate a route table with a DRG attachment, see:\n\n * [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm)\n * [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm)\nThis field is deprecated. Instead, use the networkDetails field to specify the VCN route table for this attachment.\n" maxLength: 255 minLength: 1 type: string vcnId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. This field is deprecated. Instead, use the `networkDetails` field to specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the attached resource. ' maxLength: 255 minLength: 1 type: string required: - drgId IpInventorySubnetResourceSummary: description: 'Provides the IP Inventory details of a subnet and its associated resources. ' properties: addressType: description: Address type of the allocated private IP address. items: $ref: '#/components/schemas/AddressType' type: string assignedResourceName: description: Name of the created resource. maxLength: 255 minLength: 1 type: string assignedResourceType: description: Type of the resource. enum: - Resource type: string assignedTime: description: Assigned time of the private IP address. format: date-time type: string associatedPublicIp: description: Associated public IP address for the private IP address. maxLength: 45 minLength: 7 type: string associatedPublicIpPool: description: Public IP address Pool the IP address is allocated from. enum: - ORACLE - BYOIP type: string dnsHostName: description: DNS hostname of the IP address. maxLength: 255 minLength: 1 type: string ipAddress: description: Lists the allocated private IP address. maxLength: 45 minLength: 7 type: string ipAddressLifetime: description: Lifetime of the allocated private IP address. enum: - Ephemeral - Reserved type: string ipId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IP address. maxLength: 255 minLength: 1 type: string isPrimary: default: false description: Primary flag for IP Resource type: boolean parentCidr: description: The address range the IP address is assigned from. maxLength: 45 minLength: 9 type: string publicIpLifetime: description: Lifetime of the assigned public IP address. enum: - Ephemeral - Reserved type: string PublicIp: description: 'A *public IP* is a conceptual term that refers to a public IP address and related properties. The `publicIp` object is the API representation of a public IP. There are two types of public IPs: 1. Ephemeral 2. Reserved For more information and comparison of the two types, see [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). ' properties: assignedEntityId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the entity the public IP is assigned to, or in the process of being assigned to. ' maxLength: 255 minLength: 1 type: string assignedEntityType: description: 'The type of entity the public IP is assigned to, or in the process of being assigned to. ' enum: - PRIVATE_IP - NAT_GATEWAY type: string availabilityDomain: description: 'The public IP''s availability domain. This property is set only for ephemeral public IPs that are assigned to a private IP (that is, when the `scope` of the public IP is set to AVAILABILITY_DOMAIN). The value is the availability domain of the assigned private IP. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP. For an ephemeral public IP, this is the compartment of its assigned entity (which can be a private IP or a regional entity such as a NAT gateway). For a reserved public IP that is currently assigned, its compartment can be different from the assigned private IP''s. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The public IP's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string ipAddress: description: 'The public IP address of the `publicIp` object. Example: `203.0.113.2` ' type: string lifecycleState: description: The public IP's current state. enum: - PROVISIONING - AVAILABLE - ASSIGNING - ASSIGNED - UNASSIGNING - UNASSIGNED - TERMINATING - TERMINATED type: string lifetime: description: 'Defines when the public IP is deleted and released back to Oracle''s public IP pool. * `EPHEMERAL`: The lifetime is tied to the lifetime of its assigned entity. An ephemeral public IP must always be assigned to an entity. If the assigned entity is a private IP, the ephemeral public IP is automatically deleted when the private IP is deleted, when the VNIC is terminated, or when the instance is terminated. If the assigned entity is a [NatGateway](#/en/iaas/latest/NatGateway/), the ephemeral public IP is automatically deleted when the NAT gateway is terminated. * `RESERVED`: You control the public IP''s lifetime. You can delete a reserved public IP whenever you like. It does not need to be assigned to a private IP at all times. For more information and comparison of the two types, see [Public IP Addresses](/iaas/Content/Network/Tasks/managingpublicIPs.htm). ' enum: - EPHEMERAL - RESERVED type: string privateIpId: description: 'Deprecated. Use `assignedEntityId` instead. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP that the public IP is currently assigned to, or in the process of being assigned to. **Note:** This is `null` if the public IP is not assigned to a private IP, or is in the process of being assigned to one. ' maxLength: 255 minLength: 1 type: string publicIpPoolId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the pool object created in the current tenancy. maxLength: 255 minLength: 1 type: string scope: description: 'Whether the public IP is regional or specific to a particular availability domain. * `REGION`: The public IP exists within a region and is assigned to a regional entity (such as a [NatGateway](#/en/iaas/latest/NatGateway/)), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs and ephemeral public IPs assigned to a regional entity have `scope` = `REGION`. * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity it''s assigned to, which is specified by the `availabilityDomain` property of the public IP object. Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`. ' enum: - REGION - AVAILABILITY_DOMAIN type: string timeCreated: description: 'The date and time the public IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string BulkDetachIpv6sDetails: description: Details needed to bulk detach secondary IPv6 addresses. properties: bulkDetachIpv6sItem: description: 'A secondary IPv6 address to detach. ' items: $ref: '#/components/schemas/BulkDetachIpv6sItem' maxItems: 16 minItems: 1 type: array vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC from which multiple IPv6s should be detached. The VNIC and IPv6s must be in the same subnet. ' maxLength: 255 minLength: 1 type: string required: - bulkDetachIpv6sItem SubnetTopology: allOf: - $ref: '#/components/schemas/Topology' - discriminator: propertyName: SUBNET properties: subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet for which the visualization is generated. maxLength: 255 minLength: 1 type: string description: "Defines the visualization of a subnet in a VCN. \nSee [Network Visualizer Documentation](/iaas/Content/Network/Concepts/network_visualizer.htm) for more information, including\nconventions and pictures of symbols.\n" InventoryVcnCidrBlockSummary: description: 'Lists the CIDRs and utilization within a VCN. ' properties: ipCidrBlock: description: The CIDR prefix within a VCN. maxLength: 45 minLength: 1 type: string utilization: description: The CIDR utilization of a VCN. format: float maximum: 100.0 minimum: 0.0 type: number CreateVirtualCircuitPublicPrefixDetails: properties: cidrBlock: description: 'An individual public IP prefix (CIDR) to add to the public virtual circuit. All prefix sizes are allowed. ' maxLength: 50 minLength: 4 type: string required: - cidrBlock AddDrgRouteRuleDetails: description: 'Details needed when adding a DRG route rule. ' properties: destination: description: "This is the range of IP addresses used for matching when routing\ntraffic. Only CIDR_BLOCK values are allowed.\n\nPotential values:\n * IP address range in CIDR notation. This can be an IPv4 CIDR block or IPv6 prefix. For example: `192.168.1.0/24`\n or `2001:0db8:0123:45::/56`.\n" maxLength: 255 minLength: 1 type: string destinationType: description: "Type of destination for the rule.\nAllowed values:\n * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.\n" enum: - CIDR_BLOCK type: string nextHopDrgAttachmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the next hop DRG attachment. The next hop DRG attachment is responsible for reaching the network destination. ' maxLength: 255 minLength: 1 type: string required: - destination - nextHopDrgAttachmentId - destinationType UpdateVnicDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostnameLabel: description: 'The hostname for the VNIC''s primary private IP. Used for DNS. The value is the hostname portion of the primary private IP''s fully qualified domain name (FQDN) (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). The value appears in the [Vnic](#/en/iaas/latest/Vnic/) object and also the [PrivateIp](#/en/iaas/latest/PrivateIp/) object returned by [ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp). For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). ' maxLength: 63 minLength: 1 type: string nsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) to add the VNIC to. Setting this as an empty array removes the VNIC from all network security groups. If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of belonging to a subnet), the value of the `nsgIds` attribute is ignored. Instead, the VNIC belongs to the NSGs that are associated with the VLAN itself. See [Vlan](#/en/iaas/latest/Vlan). For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object skipSourceDestCheck: description: 'Whether the source/destination check is disabled on the VNIC. Defaults to `false`, which means the check is performed. For information about why you would skip the source/destination check, see [Using a Private IP as a Route Target](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip). If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of belonging to a subnet), the value of the `skipSourceDestCheck` attribute is ignored. This is because the source/destination check is always disabled for VNICs in a VLAN. Example: `true` ' type: boolean UpdateDrgRouteDistributionDetails: description: 'Details used in a request to update a route distribution. You cannot assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route rule for an RPC attachment. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object Ipv6: description: 'An *IPv6* is a conceptual term that refers to an IPv6 address and related properties. The `IPv6` object is the API representation of an IPv6. You can create and assign an IPv6 to any VNIC that is in an IPv6-enabled subnet in an IPv6-enabled VCN. **Note:** IPv6 addressing is supported for all commercial and government regions. For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). ' properties: cidrPrefixLength: description: Length of cidr range. Optional field to specify flexible cidr. maximum: 128 minimum: 80 type: integer compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPv6. This is the same as the VNIC''s compartment. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6. maxLength: 255 minLength: 1 type: string ipAddress: description: 'The IPv6 address of the `IPv6` object. The address is within the IPv6 prefix of the VNIC''s subnet (see the `ipv6CidrBlock` attribute for the [Subnet](#/en/iaas/latest/Subnet/) object. Example: `2001:0db8:0123:1111:abcd:ef01:2345:6789` ' type: string ipState: description: 'State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE. ' enum: - ASSIGNED - AVAILABLE type: string isInternetAccessAllowed: default: true description: 'Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the IPv6 uses its public IP address for internet communication. Example: `true` ' type: boolean lifecycleState: description: The IPv6's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string lifetime: description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string publicIpAddress: description: 'The IPv6 address to be used for internet communication. The address is within the IPv6 prefix of the VNIC''s subnet (see the `ipv6PublicCidrBlock` attribute for the [Subnet](#/en/iaas/latest/Subnet/) object). If your organization did NOT assign a custom IPv6 prefix to the VCN for the private address space, Oracle provides the IPv6 prefix and uses that same prefix for the private and public address space. Therefore the `publicIpAddress` would be the same as the `ipAddress`. If your organization assigned a custom IPv6 prefix to the VCN for the address space, the right 80 bits of the IPv6 IP (the subnet and address bits) are the same as for the `ipAddress`. But the left 48 bits are from the IPv6 prefix that Oracle assigned to the VCN. This is null if the IPv6 is created with `isInternetAccessAllowed` set to `false`. Example: `2001:0db8:0123:1111:abcd:ef01:2345:6789` ' type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the IPv6 was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC the IPv6 is assigned to. The VNIC and IPv6 must be in the same subnet. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName - id - ipAddress - lifecycleState - subnetId - timeCreated ChangeInternetGatewayCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the internet gateway to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId BulkDeletePrivateIpsDetails: description: Details used tp delete Secondary IPv4 objects in a bulk operation. properties: bulkDeletePrivateIpItem: description: 'A secondary IPv4 address to delete. ' items: $ref: '#/components/schemas/BulkDeletePrivateIpItem' maxItems: 16 minItems: 1 type: array subnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the private IPs is to be deleted. ' maxLength: 255 minLength: 1 type: string vlanId: description: 'Use this attribute only with the Oracle Cloud VMware Solution. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN from which the private IP is to be deleted. ' maxLength: 255 minLength: 1 type: string vnicId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC of which \nprivate IPs should be deleted. The VNIC and private IPs must be in the same subnet.\n" maxLength: 255 minLength: 1 type: string required: - bulkDeletePrivateIpItem PortRange: properties: max: description: 'The maximum port number, which must not be less than the minimum port number. To specify a single port number, set both the min and max to the same value. ' maximum: 65535 minimum: 1 type: integer min: description: 'The minimum port number, which must not be greater than the maximum port number. ' maximum: 65535 minimum: 1 type: integer required: - max - min ChangePublicIpPoolCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination compartment for the public IP pool move. ' maxLength: 255 minLength: 1 type: string required: - compartmentId CreateIpv6Details: properties: cidrPrefixLength: default: 128 description: Length of cidr range. Optional field to specify flexible cidr. maximum: 128 minimum: 80 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipAddress: description: 'An IPv6 address of your choice. Must be an available IP address within the subnet''s CIDR. If you don''t specify a value, Oracle automatically assigns an IPv6 address from the subnet. The subnet is the one that contains the VNIC you specify in `vnicId`. Example: `2001:DB8::` ' maxLength: 45 minLength: 1 type: string ipv6SubnetCidr: description: 'The IPv6 prefix allocated to the subnet. This is required if more than one IPv6 prefix exists on the subnet. ' maxLength: 45 minLength: 1 type: string x-default-description: 'null' isInternetAccessAllowed: default: true description: 'Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the IPv6 uses its public IP address for internet communication. If `isInternetAccessAllowed` is set to `false`, the resulting `publicIpAddress` attribute for the `Ipv6` is null. Example: `true` ' type: boolean lifetime: default: EPHEMERAL description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string subnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the IPv6 is to be drawn. The IP address, *if supplied*, must be valid for the given subnet, only valid for reserved IPs currently. ' maxLength: 255 minLength: 1 type: string vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the IPv6 to. The IPv6 will be in the VNIC''s subnet. ' maxLength: 255 minLength: 1 type: string CreateDrgDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the DRG. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId DrgRouteDistribution: description: 'A route distribution establishes how routes get imported into DRG route tables and exported through the DRG attachments. A route distribution is a list of statements. Each statement consists of a set of matches, all of which must be `True` for the statement''s action to take place. Each statement determines which routes are propagated. You can assign a route distribution as a route table''s import distribution. The statements in an import route distribution specify how how incoming route advertisements through a referenced attachment or all attachments of a certain type are inserted into the route table. You can assign a route distribution as a DRG attachment''s export distribution unless the attachment has the type `VCN`. Exporting routes through a VCN attachment is unsupported. Export route distribution statements specify how routes in a DRG attachment''s assigned table are advertised out through the attachment. When a DRG is created, a route distribution is created with a single ACCEPT statement with match criteria MATCH_ALL. By default, all DRG attachments (except for those of type VCN), are assigned this distribution. You can''t create a new export route distribution, one is created for you when the DRG is created. The two auto-generated DRG route tables (one as the default for VCN attachments, and the other for all other types of attachments) are each assigned an auto generated import route distribution. The default VCN table''s import distribution has a single statement with match criteria MATCH_ALL to import routes from each DRG attachment type. The other table''s import distribution has a statement to import routes from attachments with the VCN type. The route distribution is always in the same compartment as the DRG. ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route distribution. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string distributionType: description: 'Whether this distribution defines how routes get imported into route tables or exported through DRG attachments. ' enum: - IMPORT - EXPORT type: string drgId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG that contains this route distribution. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The route distribution's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string lifecycleState: description: The route distribution's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string timeCreated: description: 'The date and time the route distribution was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - drgId - id - timeCreated - lifecycleState - compartmentId - distributionType UpdatePublicIpPoolDetails: description: The data to update for a public IP pool. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object UpdateDrgRouteTableDetails: description: 'Details used in a request to update a DRG route table. You can''t assign a table to a virtual circuit or IPSec tunnel attachment if there is a static route rule for an RPC attachment. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object importDrgRouteDistributionId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution used to specify how incoming route advertisements through referenced attachements are inserted into the DRG route table. ' maxLength: 255 minLength: 1 type: string isEcmpEnabled: description: 'If you want traffic to be routed using ECMP across your virtual circuits or IPSec tunnels to your on-prem networks, set this value to true on the route table. ' type: boolean IPSecConnectionTunnelErrorDetails: description: Details for an error on an IPSec tunnel. properties: errorCode: description: Unique code describes the error type. maxLength: 255 minLength: 1 type: string errorDescription: description: A detailed description of the error. maxLength: 1000 minLength: 1 type: string id: description: Unique ID generated for each error report. maxLength: 255 minLength: 1 type: string ociResourcesLink: description: Link to more Oracle resources or relevant documentation. maxLength: 255 minLength: 1 type: string solution: description: Resolution for the error. maxLength: 1000 minLength: 1 type: string timestamp: description: Timestamp when the error occurred. format: date-time type: string required: - id - errorCode - errorDescription - solution - ociResourcesLink - timestamp IpInventoryVcnOverlapCollection: description: The details of the overlapping VCNs and compartments. properties: ipInventoryVcnOverlapSummary: description: 'Lists `IpInventoryVcnOverlapSummary` object. ' items: $ref: '#/components/schemas/IpInventoryVcnOverlapSummary' type: array lastUpdatedTimestamp: description: 'The timestamp of the latest update from the database in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string message: description: Indicates the status of the data. maxLength: 255 minLength: 1 type: string overlapCount: description: The overlap count for the given VCN and compartments. format: int32 type: integer ChangeRouteTableCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the route table to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId Vcn: description: 'A virtual cloud network (VCN). For more information, see [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: byoipv6CidrBlocks: description: 'The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges. ' items: maxLength: 45 minLength: 1 type: string type: array uniqueItems: true cidrBlock: description: 'Deprecated. The first CIDR IP address from cidrBlocks. Example: `172.16.0.0/16` ' maxLength: 32 minLength: 1 type: string cidrBlocks: description: 'The list of IPv4 CIDR blocks the VCN will use. ' items: maxLength: 32 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VCN. maxLength: 255 minLength: 1 type: string defaultDhcpOptionsId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the VCN''s default set of DHCP options. ' maxLength: 255 minLength: 1 type: string defaultRouteTableId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default route table. maxLength: 255 minLength: 1 type: string defaultSecurityListId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the VCN's default security list. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string dnsLabel: description: 'A DNS label for the VCN, used in conjunction with the VNIC''s hostname and subnet''s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter. The value cannot be changed. The absence of this parameter means the Internet and VCN Resolver will not work for this VCN. For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `vcn1` ' maxLength: 15 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The VCN's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string ipv6CidrBlock: description: 'For an IPv6-enabled VCN, this is the IPv6 prefix for the VCN''s private IP address space. The VCN size is always /56. Oracle provides the IPv6 prefix to use as the *same* CIDR for the `ipv6PublicCidrBlock`. When creating a subnet, specify the last 8 bits, 00 to FF. See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123::/56` ' maxLength: 45 minLength: 1 type: string ipv6PrivateCidrBlocks: description: 'For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the VCN''s IP address space. ' items: maxLength: 45 minLength: 1 type: string type: array uniqueItems: true ipv6PublicCidrBlock: description: 'For an IPv6-enabled VCN, this is the IPv6 prefix for the VCN''s public IP address space. The VCN size is always /56. This prefix is always provided by Oracle. If you don''t provide a custom prefix for the `ipv6CidrBlock` when creating the VCN, Oracle assigns that value and also uses it for `ipv6PublicCidrBlock`. Oracle uses addresses from this block for the `publicIpAddress` attribute of an [Ipv6](#/en/iaas/latest/Ipv6/) that has internet access allowed. Example: `2001:0db8:0123::/48` ' maxLength: 45 minLength: 1 type: string isEncrypted: description: 'Indicates whether traffic within the VCN is encrypted. For more information, see [VN Encryption](/iaas/Content/gov-cloud/govinfo.htm#govinfo_topic_LAN-encryption). ' type: boolean isZprOnly: default: false description: 'Indicates whether ZPR Only mode is enforced. ' type: boolean lifecycleState: description: The VCN's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED - UPDATING type: string securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object timeCreated: description: 'The date and time the VCN was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnDomainName: description: 'The VCN''s domain name, which consists of the VCN''s DNS label, and the `oraclevcn.com` domain. For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `vcn1.oraclevcn.com` ' maxLength: 253 minLength: 1 type: string required: - id - compartmentId - cidrBlock - lifecycleState - cidrBlocks x-example: "{\n \"cidrBlock\" : \"10.0.0.0/16\",\n \"cidrBlocks\" : [\"10.0.0.0/16\",\"192.168.0.0/16\"],\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"defaultDhcpOptionsId\" : \"ocid1.dhcpoptions.oc1.phx.<unique_ID>\",\n \"defaultRouteTableId\" : \"ocid1.routetable.oc1.phx.<unique_ID>\",\n \"defaultSecurityListId\" : \"ocid1.securitylist.oc1.phx.<unique_ID>\",\n \"displayName\" : \"MyVcn\",\n \"id\" : \"ocid1.vcn.oc1.phx.<unique_ID>\",\n \"lifecycleState\" : \"AVAILABLE\",\n \"timeCreated\" : \"2016-11-18T22:16:24.423Z\"\n}\n" ByoasnCollection: description: The results returned by a `ListByoasn` operation. properties: items: description: A list of `Byoasn` resource summaries. items: $ref: '#/components/schemas/ByoasnSummary' type: array required: - items type: object CreateIPSecTunnelBgpSessionDetails: properties: customerBgpAsn: description: 'If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this ASN is required and used for the tunnel''s BGP session. This is the ASN of the network on the CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses "asplain" format. If the tunnel''s `routing` attribute is set to `STATIC`, the `customerBgpAsn` must be null. Example: `12345` (2-byte) or `1587232876` (4-byte) ' maxLength: 10 minLength: 1 type: string customerInterfaceIp: description: 'The IP address for the CPE end of the inside tunnel interface. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is required and used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP address to troubleshoot or monitor the tunnel. The value must be a /30 or /31. Example: `10.0.0.5/31` ' maxLength: 18 minLength: 9 type: string customerInterfaceIpv6: description: 'The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. Only subnet masks from /64 up to /127 are allowed. Example: `2001:db8::1/64` ' maxLength: 50 minLength: 4 type: string oracleInterfaceIp: description: 'The IP address for the Oracle end of the inside tunnel interface. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is required and used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP address to troubleshoot or monitor the tunnel. The value must be a /30 or /31. Example: `10.0.0.4/31` ' maxLength: 18 minLength: 9 type: string oracleInterfaceIpv6: description: 'The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. Only subnet masks from /64 up to /127 are allowed. Example: `2001:db8::1/64` ' maxLength: 50 minLength: 4 type: string Byoipv6CidrDetails: description: 'The list of one or more BYOIPv6 prefixes for the VCN that meets the following criteria: - The prefix must be from a BYOIPv6 range. - The IPv6 prefixes must be valid. - Multiple prefix must not overlap each other or the on-premises network prefix. - The number of prefixes must not exceed the limit of IPv6 prefixes allowed to a VCN. ' properties: byoipv6RangeId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. maxLength: 255 minLength: 1 type: string ipv6CidrBlock: description: 'An IPv6 prefix required to create a VCN with a BYOIP prefix. It could be the whole prefix identified in `byoipv6RangeId`, or a subrange. Example: `2001:0db8:0123::/48` ' maxLength: 45 minLength: 1 type: string required: - byoipv6RangeId - ipv6CidrBlock NatGateway: description: 'A NAT (Network Address Translation) gateway, which represents a router that lets instances without public IPs contact the public internet without exposing the instance to inbound internet traffic. For more information, see [NAT Gateway](/iaas/Content/Network/Tasks/NATgateway.htm). To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: blockTraffic: default: false description: 'Whether the NAT gateway blocks traffic through it. The default is `false`. Example: `true` ' type: boolean compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the NAT gateway. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the NAT gateway. ' maxLength: 255 minLength: 1 type: string lifecycleState: description: The NAT gateway's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string natIp: description: 'The IP address associated with the NAT gateway. ' maxLength: 255 minLength: 1 type: string publicIpId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway. ' maxLength: 255 minLength: 1 type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. If you don''t specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN''s default route table with the NAT gateway. ' maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the NAT gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the NAT gateway belongs to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - vcnId - natIp - id - lifecycleState - timeCreated - blockTraffic IPSecConnectionTunnelSharedSecret: description: The tunnel's shared secret (pre-shared key). properties: sharedSecret: description: 'The tunnel''s shared secret (pre-shared key). ' maxLength: 255 minLength: 1 type: string required: - sharedSecret Cpe: description: 'An object you create when setting up a Site-to-Site VPN between your on-premises network and VCN. The `Cpe` is a virtual representation of your customer-premises equipment, which is the actual router on-premises at your site at your end of the Site-to-Site VPN IPSec connection. For more information, see [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the CPE. maxLength: 255 minLength: 1 type: string cpeDeviceShapeId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE's device type.\nThe Networking service maintains a general list of CPE device types (for example,\nCisco ASA). For each type, Oracle provides CPE configuration content that can help\na network engineer configure the CPE. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) uniquely identifies the type of\ndevice. To get the OCIDs for the device types on the list, see\n[ListCpeDeviceShapes](#/en/iaas/latest/CpeDeviceShapeSummary/ListCpeDeviceShapes).\n\nFor information about how to generate CPE configuration content for a\nCPE device type, see:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfig)\n" maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The CPE's Oracle ID (OCID). maxLength: 255 minLength: 1 type: string ipAddress: description: The public IP address of the on-premises router. maxLength: 46 minLength: 1 type: string isPrivate: default: false description: 'Indicates whether this CPE is of type `private` or not. ' type: boolean timeCreated: description: 'The date and time the CPE was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - compartmentId - id - ipAddress ConnectLocalPeeringGatewaysDetails: description: Information about the other local peering gateway (LPG). properties: peerId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the LPG you want to peer with. maxLength: 255 minLength: 1 type: string required: - peerId CreateDrgRouteDistributionDetails: description: 'Details used to create an import route distribution. You can''t create a new export route distribution. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string distributionType: description: 'States that this distribution defines how routes get imported into route tables. ' enum: - IMPORT type: string drgId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG the DRG route table belongs to. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - drgId - distributionType RemoveNetworkSecurityGroupSecurityRulesDetails: properties: securityRuleIds: description: 'The Oracle-assigned ID of each [SecurityRule](#/en/iaas/latest/SecurityRule/) to be deleted. ' items: type: string maxItems: 25 minItems: 1 type: array CreateMacsecKey: description: Defines the secret [OCID](/iaas/Content/General/Concepts/identifiers.htm)s held in Vault that represent the MACsec key. properties: connectivityAssociationKeySecretId: description: 'Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. NOTE: Only the latest secret version will be used. ' maxLength: 255 minLength: 1 type: string connectivityAssociationNameSecretId: description: 'Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity association Key Name (CKN) of this MACsec key. NOTE: Only the latest secret version will be used. ' maxLength: 255 minLength: 1 type: string required: - connectivityAssociationNameSecretId - connectivityAssociationKeySecretId CreateCaptureFilterDetails: description: 'A capture filter contains a set of rules governing what traffic a VTAP mirrors or a VCN flow log collects. ' properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the capture filter. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string filterType: description: Indicates which service will use this capture filter enum: - VTAP type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object vtapCaptureFilterRules: description: 'The set of rules governing what traffic a VTAP mirrors. ' items: $ref: '#/components/schemas/VtapCaptureFilterRuleDetails' type: array required: - compartmentId - filterType CreateVcnDetails: properties: byoipv6CidrDetails: description: 'The list of BYOIPv6 OCIDs and BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 address ranges. ' items: $ref: '#/components/schemas/Byoipv6CidrDetails' type: array uniqueItems: true x-default-description: 'null' cidrBlock: description: '**Deprecated.** Do *not* set this value. Use `cidrBlocks` instead. Example: `10.0.0.0/16` ' maxLength: 32 minLength: 1 type: string cidrBlocks: description: 'The list of one or more IPv4 CIDR blocks for the VCN that meet the following criteria: - The CIDR blocks must be valid. - They must not overlap with each other or with the on-premises network CIDR block. - The number of CIDR blocks must not exceed the limit of CIDR blocks allowed per VCN. **Important:** Do *not* specify a value for `cidrBlock`. Use this parameter instead. ' items: maxLength: 32 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the VCN. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string dnsLabel: description: 'A DNS label for the VCN, used in conjunction with the VNIC''s hostname and subnet''s DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance1.subnet123.vcn1.oraclevcn.com`). Not required to be unique, but it''s a best practice to set unique DNS labels for VCNs in your tenancy. Must be an alphanumeric string that begins with a letter. The value cannot be changed. You must set this value if you want instances to be able to use hostnames to resolve other instances in the VCN. Otherwise the Internet and VCN Resolver will not work. For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `vcn1` ' maxLength: 15 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipv6CidrBlock: description: 'If you enable IPv6 for the VCN (see `isIpv6Enabled`), you may optionally provide an IPv6 /56 prefix from the supported ranges (see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). The addresses in this block will be considered private and cannot be accessed from the internet. The documentation refers to this as a *custom CIDR* for the VCN. If you don''t provide a custom CIDR for the VCN, Oracle assigns the VCN''s IPv6 /56 prefix. Regardless of whether you or Oracle assigns the `ipv6CidrBlock`, Oracle *also* assigns the VCN an IPv6 prefix for the VCN''s public IP address space (see the `ipv6PublicCidrBlock` of the [Vcn](#/en/iaas/latest/Vcn/) object). If you do not assign a custom prefix, Oracle uses the *same* Oracle-assigned prefix for both the private IP address space (`ipv6CidrBlock` in the `Vcn` object) and the public IP addreses space (`ipv6PublicCidrBlock` in the `Vcn` object). This means that a given VNIC might use the same IPv6 IP address for both private and public (internet) communication. You control whether an IPv6 address can be used for internet communication by using the `isInternetAccessAllowed` attribute in the [Ipv6](#/en/iaas/latest/Ipv6/) object. For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123::/48` ' maxLength: 45 minLength: 1 type: string ipv6PrivateCidrBlocks: description: 'The list of one or more ULA or Private IPv6 prefixes for the VCN that meets the following criteria: - The CIDR blocks must be valid. - Multiple CIDR blocks must not overlap each other or the on-premises network prefix. - The number of CIDR blocks must not exceed the limit of IPv6 prefixes allowed to a VCN. **Important:** Do *not* specify a value for `ipv6CidrBlock`. Use this parameter instead. ' items: maxLength: 45 minLength: 1 type: string type: array uniqueItems: true x-default-description: 'null' isEncrypted: description: 'Indicates whether traffic within the VCN is encrypted. For more information, see [VN Encryption](/iaas/Content/gov-cloud/govinfo.htm#govinfo_topic_LAN-encryption). ' type: boolean isIpv6Enabled: description: 'Whether IPv6 is enabled for the VCN. Default is `false`. If enabled, Oracle will assign the VCN a IPv6 /56 CIDR block. You may skip having Oracle allocate the VCN a IPv6 /56 CIDR block by setting isOracleGuaAllocationEnabled to `false`. For important details about IPv6 addressing in a VCN, see [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `true` ' type: boolean isOracleGuaAllocationEnabled: default: true description: 'Specifies whether to skip Oracle allocated IPv6 GUA. By default, Oracle will allocate one GUA of /56 size for an IPv6 enabled VCN. ' type: boolean isZprOnly: default: false description: 'Indicates whether ZPR Only mode is enforced. ' type: boolean securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object required: - compartmentId InventoryVcnSummary: description: Provides the summary of a VCN's IP Inventory data under specified compartments. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string dnsDomainName: description: DNS domain name of the VCN. maxLength: 255 minLength: 1 type: string inventorySubnetcollection: description: 'Lists `Subnetcollection` objects ' items: $ref: '#/components/schemas/InventorySubnetSummary' type: array inventoryVcnCidrBlockCollection: description: 'Lists `InventoryVcnCidrBlockSummary` objects. ' items: $ref: '#/components/schemas/InventoryVcnCidrBlockSummary' type: array region: description: Region name of the VCN. maxLength: 255 minLength: 1 type: string resourceType: description: Resource types of the VCN. enum: - VCN type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN . maxLength: 255 minLength: 1 type: string vcnName: description: Name of the VCN. maxLength: 255 minLength: 1 type: string DefaultPhaseTwoParameters: description: Default phase two parameters. properties: defaultAuthenticationAlgorithms: description: Default phase two authentication algorithms. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array defaultEncryptionAlgorithms: description: Default phase two encryption algorithms. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array defaultPfsDhGroup: description: Default perfect forward secrecy Diffie-Hellman groups. maxLength: 20 minLength: 1 type: string UpdateSubnetDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object dhcpOptionsId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the set of DHCP options the subnet will use. ' maxLength: 255 minLength: 1 type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipv6CidrBlock: description: 'This is the IPv6 prefix for the subnet''s private IP address space. The subnet size is always /64. See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). The provided prefix must maintain the following rules - a. The IPv6 prefix is valid and correctly formatted. b. The IPv6 prefix is within the parent VCN IPv6 range. Example: `2001:0db8:0123:1111::/64` ' maxLength: 45 minLength: 1 type: string ipv6CidrBlocks: description: 'The list of all IPv6 prefixes (Oracle allocated IPv6 GUA, ULA or private IPv6 prefix, BYOIPv6 prefixes) for the subnet that meets the following criteria: - The prefixes must be valid. - Multiple prefixes must not overlap each other or the on-premises network prefix. - The number of prefixes must not exceed the limit of IPv6 prefixes allowed to a subnet. ' items: maxLength: 45 minLength: 1 type: string type: array uniqueItems: true x-default-description: 'null' routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the subnet will use. ' maxLength: 255 minLength: 1 type: string securityListIds: description: 'The OCIDs of the security list or lists the subnet will use. This replaces the entire current set of security lists. Remember that security lists are associated *with the subnet*, but the rules are applied to the individual VNICs in the subnet. ' items: maxLength: 255 maximum: 5 minLength: 1 minimum: 0 type: string type: array IngressSecurityRule: description: A rule for allowing inbound IP packets. properties: description: description: 'An optional description of your choice for the rule. ' maxLength: 255 minLength: 1 type: string icmpOptions: $ref: '#/components/schemas/IcmpOptions' isStateless: description: 'A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if ingress traffic allows TCP destination port 80, there should be an egress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic. ' type: boolean protocol: description: 'The transport protocol. Specify either `all` or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). ' type: string source: description: "Conceptually, this is the range of IP addresses that a packet coming into the instance\ncan come from.\n\nAllowed values:\n\n * IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`.\n IPv6 addressing is supported for all commercial and government regions. See\n [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm).\n\n * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're\n setting up a security list rule for traffic coming from a particular `Service` through\n a service gateway. For example: `oci-phx-objectstorage`.\n" type: string sourceType: default: CIDR_BLOCK description: "Type of source for the rule. The default is `CIDR_BLOCK`.\n\n * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.\n\n * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic coming from a\n particular `Service` through a service gateway).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK type: string tcpOptions: $ref: '#/components/schemas/TcpOptions' udpOptions: $ref: '#/components/schemas/UdpOptions' required: - protocol - source BulkCreatePrivateIpsDetails: description: Details used to create secondary private IPv4 addresses in a bulk operation. properties: bulkCreatePrivateIpItem: description: 'A secondary IPv4 address to assign. ' items: $ref: '#/components/schemas/BulkCreatePrivateIpItem' maxItems: 16 minItems: 1 type: array subnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the private IPs is to be drawn. The IP addresses, *if supplied*, must be valid for the given subnet. ' maxLength: 255 minLength: 1 type: string vlanId: description: 'Use this attribute only with the Oracle Cloud VMware Solution. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN from which the private IPs is to be drawn. The IP addresses, *if supplied*, must be valid for the given VLAN. See [Vlan](#/en/iaas/latest/Vlan). ' maxLength: 255 minLength: 1 type: string vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the private IPs to. The VNIC and private IPs must be in the same subnet. ' maxLength: 255 minLength: 1 type: string required: - bulkCreatePrivateIpItem CreateCrossConnectGroupDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect group. maxLength: 255 minLength: 1 type: string customerReferenceName: description: 'A reference name or identifier for the physical fiber connection that this cross-connect group uses. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object macsecProperties: $ref: '#/components/schemas/CreateMacsecProperties' required: - compartmentId DrgAttachmentNetworkCreateDetails: discriminator: propertyName: type properties: id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network attached to the DRG. ' maxLength: 255 minLength: 1 type: string type: enum: - VCN type: string required: - type VirtualCircuitAssociatedTunnelDetails: description: Detailed private tunnel info associated with the virtual circuit. properties: ipsecConnectionId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of IPSec connection associated with the virtual circuit. maxLength: 255 minLength: 1 type: string tunnelId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec tunnel associated with the virtual circuit. maxLength: 255 minLength: 1 type: string tunnelType: description: The type of the tunnel associated with the virtual circuit. enum: - IPSEC type: string required: - tunnelType - tunnelId CreateCrossConnectDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the cross-connect. maxLength: 255 minLength: 1 type: string crossConnectGroupId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group to put this cross-connect in. ' maxLength: 255 minLength: 1 type: string customerReferenceName: description: 'A reference name or identifier for the physical fiber connection that this cross-connect uses. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string farCrossConnectOrCrossConnectGroupId: description: 'If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on a different router (for the purposes of redundancy), provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object interfaceName: description: 'The name of the FastConnect interface where this cross-connect is installed. ' maxLength: 255 minLength: 1 type: string locationName: description: 'The name of the FastConnect location where this cross-connect will be installed. To get a list of the available locations, see [ListCrossConnectLocations](#/en/iaas/latest/CrossConnectLocation/ListCrossConnectLocations). Example: `CyrusOne, Chandler, AZ` ' maxLength: 255 minLength: 1 type: string macsecProperties: $ref: '#/components/schemas/CreateMacsecProperties' nearCrossConnectOrCrossConnectGroupId: description: 'If you already have an existing cross-connect or cross-connect group at this FastConnect location, and you want this new cross-connect to be on the same router, provide the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of that existing cross-connect or cross-connect group. ' maxLength: 255 minLength: 1 type: string ociPhysicalDeviceName: description: 'The name of the FastConnect device where this cross-connect is installed. ' maxLength: 255 minLength: 1 type: string portSpeedShapeName: description: 'The port speed for this cross-connect. To get a list of the available port speeds, see [ListCrossConnectPortSpeedShapes](#/en/iaas/latest/CrossConnectPortSpeedShape/ListCrossconnectPortSpeedShapes). Example: `10 Gbps` ' type: string required: - locationName - portSpeedShapeName - compartmentId UpdateCrossConnectDetails: description: 'Update a CrossConnect ' properties: customerReferenceName: description: 'A reference name or identifier for the physical fiber connection this cross-connect uses. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isActive: description: 'Set to true to activate the cross-connect. You activate it after the physical cabling is complete, and you''ve confirmed the cross-connect''s light levels are good and your side of the interface is up. Activation indicates to Oracle that the physical connection is ready. Example: `true` ' type: boolean macsecProperties: $ref: '#/components/schemas/UpdateMacsecProperties' UpdateNetworkSecurityGroupDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object UpdateServiceGatewayDetails: properties: blockTraffic: default: true description: 'Whether the service gateway blocks all traffic through it. The default is `false`. When this is `true`, traffic is not routed to any services, regardless of route rules. Example: `true` ' type: boolean definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway will use. For information about why you would associate a route table with a service gateway, see [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm). ' maxLength: 255 minLength: 1 type: string services: description: 'List of all the `Service` objects you want enabled on this service gateway. Sending an empty list means you want to disable all services. Omitting this parameter entirely keeps the existing list of services intact. You can also enable or disable a particular `Service` by using [AttachServiceId](#/en/iaas/latest/ServiceGateway/AttachServiceId) or [DetachServiceId](#/en/iaas/latest/ServiceGateway/DetachServiceId). For each enabled `Service`, make sure there''s a route rule with the `Service` object''s `cidrBlock` as the rule''s destination and the service gateway as the rule''s target. See [Route Table](#/en/iaas/latest/RouteTable/). ' items: $ref: '#/components/schemas/ServiceIdRequestDetails' type: array uniqueItems: true CreateInternetGatewayDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the internet gateway. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: description: Whether the gateway is enabled upon creation. type: boolean routeTableId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using. maxLength: 255 minLength: 1 type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the Internet Gateway is attached to. maxLength: 255 minLength: 1 type: string required: - compartmentId - vcnId - isEnabled UpdateSecurityRuleDetails: description: 'A rule for allowing inbound (`direction`= INGRESS) or outbound (`direction`= EGRESS) IP packets. ' properties: description: description: 'An optional description of your choice for the rule. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string destination: description: "Conceptually, this is the range of IP addresses that a packet originating from the instance\ncan go to.\n\nAllowed values:\n\n * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`\n IPv6 addressing is supported for all commercial and government regions. See\n [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm).\n\n * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're\n setting up a security rule for traffic destined for a particular `Service` through\n a service gateway. For example: `oci-phx-objectstorage`.\n\n * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same\n VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control\n traffic between VNICs in the same NSG.\n" type: string destinationType: description: "Type of destination for the rule. Required if `direction` = `EGRESS`.\n\nAllowed values:\n\n * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.\n\n * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a\n particular `Service` through a service gateway).\n\n * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a\n [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK - NETWORK_SECURITY_GROUP type: string direction: description: 'Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets, or `INGRESS` for rules to allow inbound IP packets. ' enum: - EGRESS - INGRESS type: string icmpOptions: $ref: '#/components/schemas/IcmpOptions' id: description: 'The Oracle-assigned ID of the security rule that you want to update. You can''t change this value. Example: `04ABEC` ' maxLength: 255 minLength: 1 type: string isStateless: description: 'A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic. ' type: boolean protocol: description: 'The transport protocol. Specify either `all` or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). ' type: string source: description: "Conceptually, this is the range of IP addresses that a packet coming into the instance\ncan come from.\n\nAllowed values:\n\n * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`\n IPv6 addressing is supported for all commercial and government regions. See\n [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm).\n\n * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're\n setting up a security rule for traffic coming from a particular `Service` through\n a service gateway. For example: `oci-phx-objectstorage`.\n\n * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same\n VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control\n traffic between VNICs in the same NSG.\n" type: string sourceType: description: "Type of source for the rule. Required if `direction` = `INGRESS`.\n\n * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.\n\n * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic coming from a\n particular `Service` through a service gateway).\n\n * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a\n [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK - NETWORK_SECURITY_GROUP type: string tcpOptions: $ref: '#/components/schemas/TcpOptions' udpOptions: $ref: '#/components/schemas/UdpOptions' required: - direction - id - protocol UpdateVirtualCircuitDetails: properties: bandwidthShapeName: description: 'The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see [ListFastConnectProviderVirtualCircuitBandwidthShapes](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderVirtualCircuitBandwidthShapes). To be updated only by the customer who owns the virtual circuit. ' type: string bgpAdminState: description: 'Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit. ' enum: - ENABLED - DISABLED type: string crossConnectMappings: description: 'An array of mappings, each containing properties for a cross-connect or cross-connect group associated with this virtual circuit. The customer and provider can update different properties in the mapping depending on the situation. See the description of the [CrossConnectMapping](#/en/iaas/latest/CrossConnectMapping/). ' items: $ref: '#/components/schemas/CrossConnectMapping' maximum: 2 minimum: 0 type: array customerBgpAsn: description: 'The BGP ASN of the network at the other end of the BGP session from Oracle. If the BGP session is from the customer''s edge router to Oracle, the required value is the customer''s ASN, and it can be updated only by the customer. If the BGP session is from the provider''s edge router to Oracle, the required value is the provider''s ASN, and it can be updated only by the provider. ' type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gatewayId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [dynamic routing gateway (DRG)](#/en/iaas/latest/Drg) that this private virtual circuit uses. To be updated only by the customer who owns the virtual circuit. ' maxLength: 255 minLength: 1 type: string ipMtu: description: The layer 3 IP MTU to use on this virtual circuit. enum: - MTU_1500 - MTU_9000 type: string x-obmcs-top-level-enum: '#/definitions/VirtualCircuitIpMtu' isBfdEnabled: default: false description: 'Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`. ' type: boolean isTransportMode: default: false description: 'Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`. ' type: boolean providerServiceKeyName: description: 'The service key name offered by the provider (if the customer is connecting via a provider). ' maxLength: 255 minLength: 1 type: string providerState: description: 'The provider''s state in relation to this virtual circuit. Relevant only if the customer is using FastConnect via a provider. ACTIVE means the provider has provisioned the virtual circuit from their end. INACTIVE means the provider has not yet provisioned the virtual circuit, or has de-provisioned it. To be updated only by the provider. ' enum: - ACTIVE - INACTIVE type: string referenceComment: description: 'Provider-supplied reference information about this virtual circuit. Relevant only if the customer is using FastConnect via a provider. To be updated only by the provider. ' type: string routingPolicy: description: 'The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`. See [Route Filtering](/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details. By default, routing information is shared for all routes in the same market. ' items: enum: - ORACLE_SERVICE_NETWORK - REGIONAL - MARKET_LEVEL - GLOBAL type: string maxItems: 16 type: array CreateServiceGatewayDetails: properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to contain the service gateway. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the service gateway will use. If you don''t specify a route table here, the service gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN''s default route table with the service gateway. For information about why you would associate a route table with a service gateway, see [Transit Routing: Private Access to Oracle Services](/iaas/Content/Network/Tasks/transitroutingoracleservices.htm). ' maxLength: 255 minLength: 1 type: string services: description: 'List of the OCIDs of the [Service](#/en/iaas/latest/Service/) objects to enable for the service gateway. This list can be empty if you don''t want to enable any `Service` objects when you create the gateway. You can enable a `Service` object later by using either [AttachServiceId](#/en/iaas/latest/ServiceGateway/AttachServiceId) or [UpdateServiceGateway](#/en/iaas/latest/ServiceGateway/UpdateServiceGateway). For each enabled `Service`, make sure there''s a route rule with the `Service` object''s `cidrBlock` as the rule''s destination and the service gateway as the rule''s target. See [Route Table](#/en/iaas/latest/RouteTable/). ' items: $ref: '#/components/schemas/ServiceIdRequestDetails' type: array uniqueItems: true vcnId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - vcnId - services ByoipRange: description: 'Oracle offers the ability to Bring Your Own IP (BYOIP), importing public IP addresses or IPv6 addresses that you currently own to Oracle Cloud Infrastructure. A `ByoipRange` resource is a record of the imported address block (a BYOIP CIDR block) and also some associated metadata. The process used to [Bring Your Own IP](/iaas/Content/Network/Concepts/BYOIP.htm) is explained in the documentation.' properties: byoipRangeVcnIpv6Allocations: description: 'A list of `ByoipRangeVcnIpv6AllocationSummary` objects. ' items: $ref: '#/components/schemas/ByoipRangeVcnIpv6AllocationSummary' type: array cidrBlock: description: The public IPv4 CIDR block being imported from on-premises to the Oracle cloud. maxLength: 18 minLength: 9 type: string compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource. maxLength: 255 minLength: 1 type: string ipv6CidrBlock: description: 'The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48 or larger, and can be subdivided into sub-ranges used across multiple VCNs. A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size. ' maxLength: 45 minLength: 1 type: string lifecycleDetails: description: The `ByoipRange` resource's current status. enum: - CREATING - VALIDATING - PROVISIONED - ACTIVE - FAILED - DELETING - DELETED - ADVERTISING - WITHDRAWING type: string lifecycleState: description: The `ByoipRange` resource's current state. enum: - INACTIVE - UPDATING - ACTIVE - DELETING - DELETED type: string originAsn: $ref: '#/components/schemas/ByoipRangeOriginAsn' timeAdvertised: description: 'The date and time the `ByoipRange` resource was advertised to the internet by BGP, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeCreated: description: 'The date and time the `ByoipRange` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeValidated: description: 'The date and time the `ByoipRange` resource was validated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeWithdrawn: description: 'The date and time the `ByoipRange` resource was withdrawn from advertisement by BGP to the internet, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string validationToken: description: The validation token is an internally-generated ASCII string used in the validation process. See [Importing a CIDR block](/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - validationToken - timeCreated UpdateIPSecConnectionTunnelDetails: properties: bgpSessionConfig: $ref: '#/components/schemas/UpdateIPSecTunnelBgpSessionDetails' displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string dpdConfig: $ref: '#/components/schemas/DpdConfig' encryptionDomainConfig: $ref: '#/components/schemas/UpdateIPSecTunnelEncryptionDomainDetails' natTranslationEnabled: description: 'By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, and when it detects that the port used to forward packets has changed (most likely because a NAT device is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T even if it senses there may be a NAT device in use. ' enum: - ENABLED - DISABLED - AUTO type: string oracleInitiation: description: 'Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel. ' enum: - INITIATOR_OR_RESPONDER - RESPONDER_ONLY type: string phaseOneConfig: $ref: '#/components/schemas/PhaseOneConfigDetails' phaseTwoConfig: $ref: '#/components/schemas/PhaseTwoConfigDetails' routing: description: 'The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing). ' enum: - BGP - STATIC - POLICY type: string LocalPeeringGateway: description: 'A local peering gateway (LPG) is an object on a VCN that lets that VCN peer with another VCN in the same region. *Peering* means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the LPG. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The LPG's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string isCrossTenancyPeering: description: 'Whether the VCN at the other end of the peering is in a different tenancy. Example: `false` ' type: boolean lifecycleState: description: The LPG's current lifecycle state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string peerAdvertisedCidr: description: 'The smallest aggregate CIDR that contains all the CIDR routes advertised by the VCN at the other end of the peering from this LPG. See `peerAdvertisedCidrDetails` for the individual CIDRs. The value is `null` if the LPG is not peered. Example: `192.168.0.0/16`, or if aggregated with `172.16.0.0/24` then `128.0.0.0/1` ' maxLength: 18 minLength: 9 type: string peerAdvertisedCidrDetails: description: 'The specific ranges of IP addresses available on or via the VCN at the other end of the peering from this LPG. The value is `null` if the LPG is not peered. You can use these as destination CIDRs for route rules to route a subnet''s traffic to this LPG. Example: [`192.168.0.0/16`, `172.16.0.0/24`] ' items: maxLength: 18 minLength: 9 type: string type: array peerId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the peered LPG. maxLength: 255 minLength: 1 type: string peeringStatus: description: 'Whether the LPG is peered with another LPG. `NEW` means the LPG has not yet been peered. `PENDING` means the peering is being established. `REVOKED` means the LPG at the other end of the peering has been deleted. ' enum: - INVALID - NEW - PEERED - PENDING - REVOKED type: string peeringStatusDetails: description: Additional information regarding the peering status, if applicable. maxLength: 4096 minLength: 0 type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG is using. For information about why you would associate a route table with an LPG, see [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm). ' maxLength: 255 minLength: 1 type: string securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object timeCreated: description: 'The date and time the LPG was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN that uses the LPG. maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName - id - peerId - isCrossTenancyPeering - lifecycleState - peeringStatus - timeCreated - vcnId CrossConnectMappingDetailsCollection: description: An array of CrossConnectMappingDetails properties: items: description: CrossConnectMappingDetails items items: $ref: '#/components/schemas/CrossConnectMappingDetails' maximum: 2 minimum: 0 type: array required: - items InternetGateway: description: 'Represents a router that connects the edge of a VCN with the Internet. For an example scenario that uses an internet gateway, see [Typical Networking Service Scenarios](/iaas/Content/Network/Concepts/overview.htm#scenarios). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the internet gateway. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The internet gateway's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string isEnabled: description: 'Whether the gateway is enabled. When the gateway is disabled, traffic is not routed to/from the Internet, regardless of route rules. ' type: boolean lifecycleState: description: The internet gateway's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string routeTableId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the internet gateway was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the Internet Gateway belongs to. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - lifecycleState - vcnId x-example: "{\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"MyInternetGateway\",\n \"id\" : \"ocid1.internetgateway.oc1.phx.<unique_ID>\",\n \"isEnabled\" : true,\n \"lifecycleState\" : \"AVAILABLE\",\n \"timeCreated\" : \"2016-12-14T20:56:24.516Z\",\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\"\n}\n" CreateNetworkSecurityGroupDetails: properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the network security group. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object vcnId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN to create the network security group in. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - vcnId BulkCreateIpv6sItem: description: Secondary IPv6 object to use as part of bulk IPv6 object creation. properties: cidrPrefixLength: default: 128 description: Length of the CIDR range. Optional field to specify a flexible CIDR. maximum: 128 minimum: 80 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipAddress: description: 'An IPv6 address of your choice. Must be an available IP address within the subnet''s CIDR. If you don''t specify a value, Oracle automatically assigns an IPv6 address from the subnet. The subnet is the one that contains the VNIC you specify in `vnicId`. Example: `2001:DB8::` ' maxLength: 45 minLength: 1 type: string ipv6SubnetCidr: description: 'The IPv6 prefix allocated to the subnet. This is required if more than one IPv6 prefix exists on the subnet. ' maxLength: 45 minLength: 1 type: string x-default-description: 'null' isInternetAccessAllowed: default: true description: 'Whether the IPv6 can be used for internet communication. Allowed by default for an IPv6 in a public subnet. Never allowed for an IPv6 in a private subnet. If the value is `true`, the IPv6 uses its public IP address for internet communication. If `isInternetAccessAllowed` is set to `false`, the resulting `publicIpAddress` attribute for the `Ipv6` is null. Example: `true` ' type: boolean lifetime: default: EPHEMERAL description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string CreateMacsecProperties: description: Properties used to configure MACsec (if capable). properties: encryptionCipher: description: Type of encryption cipher suite to use for the MACsec connection. enum: - AES128_GCM - AES128_GCM_XPN - AES256_GCM - AES256_GCM_XPN type: string x-obmcs-top-level-enum: '#/definitions/MacsecEncryptionCipher' isUnprotectedTrafficAllowed: default: false description: Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. type: boolean primaryKey: $ref: '#/components/schemas/CreateMacsecKey' state: description: Indicates whether or not MACsec is enabled. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/MacsecState' required: - state IpInventoryVcnOverlapSummary: description: 'Provides the VCN overlap details. ' properties: cidr: description: CIDR prefix of the VCN. maxLength: 45 minLength: 1 type: string overlappingCidr: description: The overlapping CIDR prefix. maxLength: 45 minLength: 1 type: string overlappingVcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN . maxLength: 255 minLength: 1 type: string overlappingVcnName: description: Name of the overlapping VCN. maxLength: 255 minLength: 1 type: string TunnelStatus: description: 'Deprecated. For tunnel information, instead see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/). ' properties: ipAddress: description: 'The IP address of Oracle''s VPN headend. Example: `203.0.113.50` ' maxLength: 46 minLength: 1 type: string lifecycleState: description: The tunnel's current state. enum: - UP - DOWN - DOWN_FOR_MAINTENANCE - PARTIAL_UP type: string timeCreated: description: 'The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStateModified: description: 'When the state of the tunnel last changed, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - ipAddress CpeDeviceConfigQuestion: description: 'An individual question that the customer can answer about the CPE device. The customer provides answers to these questions in [UpdateTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/UpdateTunnelCpeDeviceConfig). ' properties: displayName: description: 'A descriptive label for the question (for example, to display in a form in a graphical interface). Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string explanation: description: 'A description or explanation of the question, to help the customer answer accurately. ' maxLength: 255 minLength: 1 type: string key: description: 'A string that identifies the question. ' maxLength: 255 minLength: 1 type: string AddDrgRouteDistributionStatementsDetails: description: 'Details request to add statements to a route distribution. ' properties: statements: description: 'The collection of route distribution statements to insert into the route distribution. ' items: $ref: '#/components/schemas/AddDrgRouteDistributionStatementDetails' maxItems: 100 minItems: 0 type: array required: - statements InventoryResourceSummary: description: Lists resources and its properties under a given subnet. properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. maxLength: 255 minLength: 1 type: string ipAddressCollection: description: 'Lists the ''IpAddressCollection'' object. ' items: $ref: '#/components/schemas/InventoryIpAddressSummary' type: array macAddress: description: Mac Address of IP Resource maxLength: 255 minLength: 1 type: string region: description: The region name of the corresponding resource. maxLength: 255 minLength: 1 type: string resourceName: description: The name of the resource created. maxLength: 255 minLength: 1 type: string resourceType: description: Resource types of the resource. enum: - Resource type: string UpdateDrgRouteRulesDetails: description: 'Details used to update route rules in a DRG route table. ' properties: routeRules: description: The DRG rute rules to update. items: $ref: '#/components/schemas/UpdateDrgRouteRuleDetails' maxItems: 100 minItems: 1 type: array ByoipAllocatedRangeCollection: description: Results of a `ListByoipAllocatedRanges` operation. properties: items: description: A list of subranges of a BYOIP CIDR block allocated to an IP pool. items: $ref: '#/components/schemas/ByoipAllocatedRangeSummary' type: array required: - items type: object CrossConnectMappingDetails: description: 'For use with Oracle Cloud Infrastructure FastConnect. Each [VirtualCircuit](#/en/iaas/latest/VirtualCircuit/) runs on one or more cross-connects or cross-connect groups. A `CrossConnectMappingDetails` contains the properties for an individual cross-connect or cross-connect group associated with a given virtual circuit. The details includes information about the cross-connect or cross-connect group, the VLAN, and the BGP peering session. ' properties: bgpMd5AuthKey: description: 'The key for BGP MD5 authentication. Only applicable if your system requires MD5 authentication. If empty or not set (null), that means you don''t use BGP MD5 authentication. ' maxLength: 255 minLength: 1 type: string crossConnectOrCrossConnectGroupId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect or cross-connect group for this mapping. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). ' maxLength: 255 minLength: 1 type: string customerBgpPeeringIp: description: 'The BGP IPv4 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv4 address of the customer''s edge router. If the session goes from Oracle to a provider, this is the BGP IPv4 address of the provider''s edge router. Must use a subnet mask from /28 to /31. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. Example: `10.0.0.18/31` ' maxLength: 46 minLength: 7 type: string customerBgpPeeringIpv6: description: 'The BGP IPv6 address for the router on the other end of the BGP session from Oracle. Specified by the owner of that router. If the session goes from Oracle to a customer, this is the BGP IPv6 address of the customer''s edge router. If the session goes from Oracle to a provider, this is the BGP IPv6 address of the provider''s edge router. Only subnet masks from /64 up to /127 are allowed. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. Example: `2001:db8::1/64` ' maxLength: 50 minLength: 4 type: string ipv4BgpStatus: description: The state of the Ipv4 BGP session. enum: - UP - DOWN type: string ipv6BgpStatus: description: The state of the Ipv6 BGP session. enum: - UP - DOWN type: string ociLogicalDeviceName: description: 'The FastConnect device that terminates the logical connection. ' maxLength: 255 minLength: 1 type: string oracleBgpPeeringIp: description: 'The IPv4 address for Oracle''s end of the BGP session. Must use a subnet mask from /28 to /31. If the session goes from Oracle to a customer''s edge router, the customer specifies this information. If the session goes from Oracle to a provider''s edge router, the provider specifies this. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv4 addresses. Example: `10.0.0.19/31` ' maxLength: 46 minLength: 7 type: string oracleBgpPeeringIpv6: description: 'The IPv6 address for Oracle''s end of the BGP session. Only subnet masks from /64 up to /127 are allowed. If the session goes from Oracle to a customer''s edge router, the customer specifies this information. If the session goes from Oracle to a provider''s edge router, the provider specifies this. There''s one exception: for a public virtual circuit, Oracle specifies the BGP IPv6 addresses. Example: `2001:db8::2/64` ' maxLength: 50 minLength: 4 type: string vlan: description: 'The number of the specific VLAN (on the cross-connect or cross-connect group) that is assigned to this virtual circuit. Specified by the owner of the cross-connect or cross-connect group (the customer if the customer is colocated with Oracle, or the provider if the customer is connecting via provider). Example: `200` ' maximum: 16777216 minimum: 100 type: integer ChangeIPSecConnectionCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the IPSec connection to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId CpeDeviceShapeSummary: description: 'A summary of information about a particular CPE device type. Compare with [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/). ' properties: cpeDeviceInfo: $ref: '#/components/schemas/CpeDeviceInfo' id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. This value uniquely identifies the type of CPE device. ' maxLength: 255 minLength: 1 type: string Drg: description: 'A dynamic routing gateway (DRG) is a virtual router that provides a path for private network traffic between networks. You use it with other Networking Service components to create a connection to your on-premises network using [Site-to-Site VPN](/iaas/Content/Network/Tasks/managingIPsec.htm) or a connection that uses [FastConnect](/iaas/Content/Network/Concepts/fastconnect.htm). For more information, see [Networking Overview](/iaas/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the DRG. maxLength: 255 minLength: 1 type: string defaultDrgRouteTables: $ref: '#/components/schemas/DefaultDrgRouteTables' defaultExportDrgRouteDistributionId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of this DRG''s default export route distribution for the DRG attachments. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The DRG's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string lifecycleState: description: The DRG's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string timeCreated: description: 'The date and time the DRG was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - compartmentId - id - lifecycleState x-example: "{\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"MyDrg\",\n \"id\" : \"ocid1.drg.oc1.phx.<unique_ID>\",\n \"lifecycleState\" : \"PROVISIONING\",\n \"timeCreated\" : \"2016-12-16T22:34:20.948Z\"\n}\n" CreateIPSecConnectionTunnelDetails: properties: associatedVirtualCircuits: description: 'The list of virtual circuit [OCID](/iaas/Content/General/Concepts/identifiers.htm)s over which your network can reach this tunnel. ' items: maxLength: 255 minLength: 1 type: string type: array uniqueItems: true bgpSessionConfig: $ref: '#/components/schemas/CreateIPSecTunnelBgpSessionDetails' displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string dpdConfig: $ref: '#/components/schemas/DpdConfig' drgRouteTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to this attachment. The DRG route table manages traffic inside the DRG. ' maxLength: 255 minLength: 1 type: string encryptionDomainConfig: $ref: '#/components/schemas/CreateIPSecTunnelEncryptionDomainDetails' natTranslationEnabled: description: 'By default (the `AUTO` setting), IKE sends packets with a source and destination port set to 500, and when it detects that the port used to forward packets has changed (most likely because a NAT device is between the CPE device and the Oracle VPN headend) it will try to negotiate the use of NAT-T. The `ENABLED` option sets the IKE protocol to use port 4500 instead of 500 and forces encapsulating traffic with the ESP protocol inside UDP packets. The `DISABLED` option directs IKE to completely refuse to negotiate NAT-T even if it senses there may be a NAT device in use. ' enum: - ENABLED - DISABLED - AUTO type: string oracleInitiation: description: 'Indicates whether the Oracle end of the IPSec connection is able to initiate starting up the IPSec tunnel. ' enum: - INITIATOR_OR_RESPONDER - RESPONDER_ONLY type: string oracleTunnelIp: description: 'The headend IP that you can choose on the Oracle side to terminate your private IPSec tunnel. ' maxLength: 32 minLength: 1 type: string phaseOneConfig: $ref: '#/components/schemas/PhaseOneConfigDetails' phaseTwoConfig: $ref: '#/components/schemas/PhaseTwoConfigDetails' routing: description: 'The type of routing to use for this tunnel (BGP dynamic routing, static routing, or policy-based routing). ' enum: - BGP - STATIC - POLICY type: string sharedSecret: description: 'The shared secret (pre-shared key) to use for the IPSec tunnel. Only numbers, letters, and spaces are allowed. If you don''t provide a value, Oracle generates a value for you. You can specify your own shared secret later if you like with [UpdateIPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/UpdateIPSecConnectionTunnelSharedSecret). ' maxLength: 255 minLength: 1 type: string UpdatedNetworkSecurityGroupSecurityRules: properties: securityRules: description: The NSG security rules that were updated. items: $ref: '#/components/schemas/SecurityRule' type: array FastConnectProviderServiceKey: description: 'A provider service key and its details. A provider service key is an identifier for a provider''s virtual circuit. ' properties: bandwidthShapeName: description: 'The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see [ListFastConnectProviderServiceVirtualCircuitBandwidthShapes](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderVirtualCircuitBandwidthShapes). Example: `10 Gbps` ' type: string name: description: 'The service key that the provider gives you when you set up a virtual circuit connection from the provider to Oracle Cloud Infrastructure. Use this value as the `providerServiceKeyName` query parameter for [GetFastConnectProviderServiceKey](#/en/iaas/latest/FastConnectProviderServiceKey/GetFastConnectProviderServiceKey). ' maxLength: 255 minLength: 1 type: string peeringLocation: description: The provider's peering location. maxLength: 255 minLength: 1 type: string required: - name CpeDeviceInfo: description: Basic information about a particular CPE device type. properties: platformSoftwareVersion: description: The platform or software version of the CPE device. maxLength: 255 minLength: 1 type: string vendor: description: The vendor that makes the CPE device. maxLength: 255 minLength: 1 type: string SecurityRule: description: 'A security rule is one of the items in a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). It is a virtual firewall rule for the VNICs in the network security group. A rule can be for either inbound (`direction`= INGRESS) or outbound (`direction`= EGRESS) IP packets. ' properties: description: description: 'An optional description of your choice for the rule. ' maxLength: 255 minLength: 1 type: string destination: description: "Conceptually, this is the range of IP addresses that a packet originating from the instance\ncan go to.\n\nAllowed values:\n\n * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`\n IPv6 addressing is supported for all commercial and government regions.\n See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm).\n\n * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're\n setting up a security rule for traffic destined for a particular `Service` through\n a service gateway. For example: `oci-phx-objectstorage`.\n\n * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same\n VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control\n traffic between VNICs in the same NSG.\n" type: string destinationType: description: "Type of destination for the rule. Required if `direction` = `EGRESS`.\n\nAllowed values:\n\n * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.\n\n * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a\n particular `Service` through a service gateway).\n\n * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a\n [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK - NETWORK_SECURITY_GROUP type: string direction: description: 'Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets, or `INGRESS` for rules to allow inbound IP packets. ' enum: - EGRESS - INGRESS type: string icmpOptions: $ref: '#/components/schemas/IcmpOptions' id: description: 'An Oracle-assigned identifier for the security rule. You specify this ID when you want to update or delete the rule. Example: `04ABEC` ' maxLength: 255 minLength: 1 type: string isStateless: description: 'A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic. ' type: boolean isValid: description: 'Whether the rule is valid. The value is `True` when the rule is first created. If the rule''s `source` or `destination` is a network security group, the value changes to `False` if that network security group is deleted. ' type: boolean protocol: description: 'The transport protocol. Specify either `all` or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). ' type: string source: description: "Conceptually, this is the range of IP addresses that a packet coming into the instance\ncan come from.\n\nAllowed values:\n\n * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`\n IPv6 addressing is supported for all commercial and government regions.\n See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm).\n\n * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're\n setting up a security rule for traffic coming from a particular `Service` through\n a service gateway. For example: `oci-phx-objectstorage`.\n\n * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same\n VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control\n traffic between VNICs in the same NSG.\n" type: string sourceType: description: "Type of source for the rule. Required if `direction` = `INGRESS`.\n\n * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.\n\n * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic coming from a\n particular `Service` through a service gateway).\n\n * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a\n [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK - NETWORK_SECURITY_GROUP type: string tcpOptions: $ref: '#/components/schemas/TcpOptions' timeCreated: description: The date and time the security rule was created. Format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). format: date-time type: string udpOptions: $ref: '#/components/schemas/UdpOptions' required: - direction - protocol RemoveVcnCidrDetails: description: Details for removing a CIDR block from a VCN. properties: cidrBlock: description: 'The CIDR block to remove. ' maxLength: 18 minLength: 9 type: string required: - cidrBlock PublicIpPool: description: 'A public IP pool is a set of public IP addresses represented as one or more IPv4 CIDR blocks. Resources like load balancers and compute instances can be allocated public IP addresses from a public IP pool. ' properties: cidrBlocks: description: 'The CIDR blocks added to this pool. This could be all or a portion of a BYOIP CIDR block. ' items: maxLength: 255 minLength: 1 type: string type: array compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing this pool. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool. maxLength: 255 minLength: 1 type: string lifecycleState: description: The public IP pool's current state. enum: - INACTIVE - UPDATING - ACTIVE - DELETING - DELETED type: string timeCreated: description: 'The date and time the public IP pool was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - timeCreated UpdateNetworkSecurityGroupSecurityRulesDetails: properties: securityRules: description: The NSG security rules to update. items: $ref: '#/components/schemas/UpdateSecurityRuleDetails' maxItems: 25 minItems: 1 type: array AllowedIkeIPSecParameters: description: Lists the current allowed and default IPSec tunnel parameters. properties: allowedPhaseOneParameters: $ref: '#/components/schemas/AllowedPhaseOneParameters' allowedPhaseTwoParameters: $ref: '#/components/schemas/AllowedPhaseTwoParameters' defaultPhaseOneParameters: $ref: '#/components/schemas/DefaultPhaseOneParameters' defaultPhaseTwoParameters: $ref: '#/components/schemas/DefaultPhaseTwoParameters' required: - allowedPhaseOneParameters - allowedPhaseTwoParameters - defaultPhaseOneParameters - defaultPhaseTwoParameters IpInventoryCidrUtilizationSummary: description: 'The CIDR utilization details of a subnet. ' properties: addressType: description: Address type of the CIDR within a subnet. items: $ref: '#/components/schemas/AddressType' type: string cidr: description: The CIDR range of a subnet. maxLength: 45 minLength: 1 type: string utilization: description: The CIDR utilisation of a subnet. format: float maximum: 100.0 minimum: 0.0 type: number Error: properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. See [API Errors](/iaas/Content/API/References/apierrors.htm). ' type: string message: description: A human-readable error message. type: string messageArguments: additionalProperties: type: string description: 'The values to be substituted into the `originalMessageTemplate`, expressed as a string-to-string map. ' type: object originalMessage: description: A human-readable error string in English. This value might be different from the `message` field. type: string originalMessageTemplate: description: 'The template for the `originalMessage` in ICU message format, but without the values to be substituted. ' type: string required: - code - message RemotePeeringConnection: description: 'A remote peering connection (RPC) is an object on a DRG that lets the VCN that is attached to the DRG peer with a VCN in a different region. *Peering* means that the two VCNs can communicate using private IP addresses, but without the traffic traversing the internet or routing through your on-premises network. For more information, see [VCN Peering](/iaas/Content/Network/Tasks/VCNpeering.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the RPC. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string drgId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG that this RPC belongs to. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the RPC. maxLength: 255 minLength: 1 type: string isCrossTenancyPeering: description: 'Whether the VCN at the other end of the peering is in a different tenancy. Example: `false` ' type: boolean lifecycleState: description: The RPC's current lifecycle state. enum: - AVAILABLE - PROVISIONING - TERMINATING - TERMINATED type: string peerId: description: 'If this RPC is peered, this value is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the other RPC. ' maxLength: 255 minLength: 1 type: string peerRegionName: description: 'If this RPC is peered, this value is the region that contains the other RPC. Example: `us-ashburn-1` ' maxLength: 255 minLength: 1 type: string peerTenancyId: description: 'If this RPC is peered, this value is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the other RPC''s tenancy. ' maxLength: 255 minLength: 1 type: string peeringStatus: description: 'Whether the RPC is peered with another RPC. `NEW` means the RPC has not yet been peered. `PENDING` means the peering is being established. `REVOKED` means the RPC at the other end of the peering has been deleted. ' enum: - INVALID - NEW - PENDING - PEERED - REVOKED type: string timeCreated: description: 'The date and time the RPC was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - compartmentId - displayName - drgId - id - isCrossTenancyPeering - lifecycleState - peeringStatus - timeCreated DefaultPhaseOneParameters: description: Default phase one parameters. properties: defaultAuthenticationAlgorithms: description: Default phase one authentication algorithms. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array defaultDhGroups: description: Default phase one Diffie-Hellman groups. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array defaultEncryptionAlgorithms: description: Default phase one encryption algorithms. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array UpdateInternetGatewayDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEnabled: description: Whether the gateway is enabled. type: boolean routeTableId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the Internet Gateway is using. maxLength: 255 minLength: 1 type: string Vlan: description: 'A resource to be used only with the Oracle Cloud VMware Solution. Conceptually, a virtual LAN (VLAN) is a broadcast domain that is created by partitioning and isolating a network at the data link layer (a *layer 2 network*). VLANs work by using IEEE 802.1Q VLAN tags. Layer 2 traffic is forwarded within the VLAN based on MAC learning. In the Networking service, a VLAN is an object within a VCN. You use VLANs to partition the VCN at the data link layer (layer 2). A VLAN is analagous to a subnet, which is an object for partitioning the VCN at the IP layer (layer 3). ' properties: availabilityDomain: description: 'The availability domain of the VLAN. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string cidrBlock: description: 'The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. Example: `192.168.1.0/24` ' maxLength: 32 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VLAN. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The VLAN's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string lifecycleState: description: The VLAN's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED - UPDATING type: string nsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) to use with this VLAN. All VNICs in the VLAN belong to these NSGs. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true routeTableId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table that the VLAN uses. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the VLAN was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the VLAN is in. maxLength: 255 minLength: 1 type: string vlanTag: description: 'The IEEE 802.1Q VLAN tag of this VLAN. Example: `100` ' format: int32 type: integer required: - id - compartmentId - cidrBlock - lifecycleState - vcnId Vtap: description: 'A virtual test access point (VTAP) provides a way to mirror all traffic from a designated source to a selected target in order to facilitate troubleshooting, security analysis, and data monitoring. A VTAP is functionally similar to a test access point (TAP) you might deploy in your on-premises network. A *[capture filter](#/en/iaas/latest/CaptureFilter)* contains a set of *[rules](#/en/iaas/latest/datatypes/CaptureFilterRuleDetails)* governing what traffic a VTAP mirrors. ' properties: captureFilterId: description: 'The capture filter''s Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). ' maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Vtap` resource. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string encapsulationProtocol: description: 'Defines an encapsulation header type for the VTAP''s mirrored traffic. ' enum: - VXLAN type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The VTAP's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string isVtapEnabled: default: false description: 'Used to start or stop a `Vtap` resource. * `TRUE` directs the VTAP to start mirroring traffic. * `FALSE` (Default) directs the VTAP to stop mirroring traffic. ' type: boolean lifecycleState: description: The VTAP's administrative lifecycle state. enum: - PROVISIONING - AVAILABLE - UPDATING - TERMINATING - TERMINATED type: string lifecycleStateDetails: description: The VTAP's current running state. enum: - RUNNING - STOPPED type: string maxPacketSize: description: The maximum size of the packets to be included in the filter. format: int32 type: integer sourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. ' maxLength: 255 minLength: 1 type: string sourcePrivateEndpointIp: description: 'The IP Address of the source private endpoint. ' maxLength: 46 minLength: 1 type: string sourcePrivateEndpointSubnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. ' maxLength: 255 minLength: 1 type: string sourceType: description: 'The source type for the VTAP. ' enum: - VNIC - SUBNET - LOAD_BALANCER - DB_SYSTEM - EXADATA_VM_CLUSTER - AUTONOMOUS_DATA_WAREHOUSE type: string targetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. ' maxLength: 255 minLength: 1 type: string targetIp: description: 'The IP address of the destination resource where mirrored packets are sent. ' maxLength: 46 minLength: 1 type: string targetType: description: 'The target type for the VTAP. ' enum: - VNIC - NETWORK_LOAD_BALANCER - IP_ADDRESS type: string timeCreated: description: 'The date and time the VTAP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2020-08-25T21:10:29.600Z` ' format: date-time type: string trafficMode: default: DEFAULT description: Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT enum: - DEFAULT - PRIORITY type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN containing the `Vtap` resource. maxLength: 255 minLength: 1 type: string vxlanNetworkIdentifier: description: 'The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. ' format: int64 type: integer required: - compartmentId - vcnId - id - lifecycleState - sourceId - captureFilterId UpdateDrgDetails: properties: defaultDrgRouteTables: $ref: '#/components/schemas/DefaultDrgRouteTables' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object BgpSessionInfo: description: Information for establishing a BGP session for the IPSec tunnel. properties: bgpIpv6State: description: 'The state of the BGP IPv6 session. ' enum: - UP - DOWN type: string bgpState: description: 'The state of the BGP session. ' enum: - UP - DOWN type: string customerBgpAsn: description: 'If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this ASN is required and used for the tunnel''s BGP session. This is the ASN of the network on the CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses "asplain" format. If the tunnel uses static routing, the `customerBgpAsn` must be null. Example: `12345` (2-byte) or `1587232876` (4-byte) ' maxLength: 10 minLength: 1 type: string customerInterfaceIp: description: 'The IP address for the CPE end of the inside tunnel interface. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is required and used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP address so you can troubleshoot or monitor the tunnel. The value must be a /30 or /31. Example: `10.0.0.5/31` ' maxLength: 18 type: string customerInterfaceIpv6: description: 'The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. Only subnet masks from /64 up to /127 are allowed. Example: `2001:db8::1/64` ' maxLength: 50 type: string oracleBgpAsn: description: 'The Oracle BGP ASN. ' maxLength: 10 minLength: 1 type: string oracleInterfaceIp: description: 'The IP address for the Oracle end of the inside tunnel interface. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is required and used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, this IP address is optional. You can set this IP address so you can troubleshoot or monitor the tunnel. The value must be a /30 or /31. Example: `10.0.0.4/31` ' maxLength: 18 type: string oracleInterfaceIpv6: description: 'The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. Only subnet masks from /64 up to /127 are allowed. Example: `2001:db8::1/64` ' maxLength: 50 type: string DrgAttachmentInfo: description: 'The `DrgAttachmentInfo` resource contains the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment. ' properties: id: description: 'The Oracle-assigned ID of the DRG attachment ' maxLength: 255 minLength: 1 type: string required: - id VirtualCircuit: description: 'For use with Oracle Cloud Infrastructure FastConnect. A virtual circuit is an isolated network path that runs over one or more physical network connections to provide a single, logical connection between the edge router on the customer''s existing network and Oracle Cloud Infrastructure. *Private* virtual circuits support private peering, and *public* virtual circuits support public peering. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). Each virtual circuit is made up of information shared between a customer, Oracle, and a provider (if the customer is using FastConnect via a provider). Who fills in a given property of a virtual circuit depends on whether the BGP session related to that virtual circuit goes from the customer''s edge router to Oracle, or from the provider''s edge router to Oracle. Also, in the case where the customer is using a provider, values for some of the properties may not be present immediately, but may get filled in as the provider and Oracle each do their part to provision the virtual circuit. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: bandwidthShapeName: description: 'The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see [ListFastConnectProviderServiceVirtualCircuitBandwidthShapes](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderVirtualCircuitBandwidthShapes). Example: `10 Gbps` ' type: string bgpAdminState: description: 'Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit. ' enum: - ENABLED - DISABLED type: string bgpIpv6SessionState: description: The state of the Ipv6 BGP session associated with the virtual circuit. enum: - UP - DOWN type: string bgpManagement: description: 'Deprecated. Instead use the information in [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/). ' enum: - CUSTOMER_MANAGED - PROVIDER_MANAGED - ORACLE_MANAGED type: string bgpSessionState: description: The state of the Ipv4 BGP session associated with the virtual circuit. enum: - UP - DOWN type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the virtual circuit. maxLength: 255 minLength: 1 type: string crossConnectMappings: description: 'An array of mappings, each containing properties for a cross-connect or cross-connect group that is associated with this virtual circuit. ' items: $ref: '#/components/schemas/CrossConnectMapping' maximum: 2 minimum: 0 type: array customerBgpAsn: description: 'The BGP ASN of the network at the other end of the BGP session from Oracle. If the session is between the customer''s edge router and Oracle, the value is the customer''s ASN. If the BGP session is between the provider''s edge router and Oracle, the value is the provider''s ASN. ' type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gatewayId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the customer''s [dynamic routing gateway (DRG)](#/en/iaas/latest/Drg) that this virtual circuit uses. Applicable only to private virtual circuits. ' maxLength: 255 minLength: 1 type: string id: description: The virtual circuit's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string ipMtu: description: The layer 3 IP MTU to use on this virtual circuit. enum: - MTU_1500 - MTU_9000 type: string x-obmcs-top-level-enum: '#/definitions/VirtualCircuitIpMtu' isBfdEnabled: default: false description: 'Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`. ' type: boolean isTransportMode: default: false description: 'Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`. ' type: boolean lifecycleState: description: 'The virtual circuit''s current state. For information about the different states, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). ' enum: - PENDING_PROVIDER - VERIFYING - PROVISIONING - PROVISIONED - FAILED - INACTIVE - TERMINATING - TERMINATED type: string oracleBgpAsn: description: The Oracle BGP ASN. type: integer providerName: description: 'Deprecated. Instead use `providerServiceId`. ' maxLength: 255 minLength: 1 type: string providerServiceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider (if the customer is connecting via a provider). ' maxLength: 255 minLength: 1 type: string providerServiceKeyName: description: 'The service key name offered by the provider (if the customer is connecting via a provider). ' maxLength: 255 minLength: 1 type: string providerServiceName: description: 'Deprecated. Instead use `providerServiceId`. ' maxLength: 255 minLength: 1 type: string providerState: description: 'The provider''s state in relation to this virtual circuit (if the customer is connecting via a provider). ACTIVE means the provider has provisioned the virtual circuit from their end. INACTIVE means the provider has not yet provisioned the virtual circuit, or has de-provisioned it. ' enum: - ACTIVE - INACTIVE type: string publicPrefixes: description: 'For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. All prefix sizes are allowed. ' items: maxLength: 50 minLength: 9 type: string maximum: 50 minimum: 0 type: array referenceComment: description: 'Provider-supplied reference information about this virtual circuit (if the customer is connecting via a provider). ' type: string region: description: 'The Oracle Cloud Infrastructure region where this virtual circuit is located. ' maxLength: 255 minLength: 1 type: string routingPolicy: description: 'The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`. See [Route Filtering](/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details. By default, routing information is shared for all routes in the same market. ' items: enum: - ORACLE_SERVICE_NETWORK - REGIONAL - MARKET_LEVEL - GLOBAL type: string maxItems: 16 type: array serviceType: description: 'Provider service type. ' enum: - COLOCATED - LAYER2 - LAYER3 type: string timeCreated: description: 'The date and time the virtual circuit was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: description: 'Whether the virtual circuit supports private or public peering. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). ' enum: - PUBLIC - PRIVATE type: string virtualCircuitRedundancyMetadata: $ref: '#/components/schemas/VirtualCircuitRedundancyMetadata' PrivateIp: description: 'A *private IP* is a conceptual term that refers to an IPv4 private IP address and related properties. The `privateIp` object is the API representation of a private IP. **Note:** For information about IPv6 addresses, see [Ipv6](#/en/iaas/latest/Ipv6/). Each instance has a *primary private IP* that is automatically created and assigned to the primary VNIC during instance launch. If you add a secondary VNIC to the instance, it also automatically gets a primary private IP. You can''t remove a primary private IP from its VNIC. The primary private IP is automatically deleted when the VNIC is terminated. You can add *secondary private IPs* to a VNIC after it''s created. For more information, see the `privateIp` operations and also [IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm). **Note:** Only [ListPrivateIps](#/en/iaas/latest/PrivateIp/ListPrivateIps) and [GetPrivateIp](#/en/iaas/latest/PrivateIp/GetPrivateIp) work with *primary* private IPs. To create and update primary private IPs, you instead work with instance and VNIC operations. For example, a primary private IP''s properties come from the values you specify in [CreateVnicDetails](#/en/iaas/latest/CreateVnicDetails/) when calling either [LaunchInstance](#/en/iaas/latest/Instance/LaunchInstance) or [AttachVnic](#/en/iaas/latest/VnicAttachment/AttachVnic). To update the hostname for a primary private IP, you use [UpdateVnic](#/en/iaas/latest/Vnic/UpdateVnic). `PrivateIp` objects that are created for use with the Oracle Cloud VMware Solution are assigned to a VLAN and not a VNIC in a subnet. See the descriptions of the relevant attributes in the `PrivateIp` object. Also see [Vlan](#/en/iaas/latest/Vlan). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: availabilityDomain: description: 'The private IP''s availability domain. This attribute will be null if this is a *secondary* private IP assigned to a VNIC that is in a *regional* subnet. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string cidrPrefixLength: description: The secondary IPv4 CIDR prefix length. maximum: 32 minimum: 18 type: integer compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the private IP. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostnameLabel: description: 'The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP''s fully qualified domain name (FQDN) (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `bminstance1` ' maxLength: 63 minLength: 1 type: string id: description: The private IP's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string ipAddress: description: 'The private IP address of the `privateIp` object. The address is within the CIDR of the VNIC''s subnet. However, if the `PrivateIp` object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the address is from the range specified by the `cidrBlock` attribute for the VLAN. See [Vlan](#/en/iaas/latest/Vlan). Example: `10.0.3.3` ' type: string ipState: description: 'State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE. ' enum: - ASSIGNED - AVAILABLE type: string ipv4SubnetCidrAtCreation: description: 'Ipv4 Subnet CIDR specified whn creating the PrivateIP. ' maxLength: 32 minLength: 1 type: string isPrimary: description: 'Whether this private IP is the primary one on the VNIC. Primary private IPs are unassigned and deleted automatically when the VNIC is terminated. Example: `true` ' type: boolean lifetime: description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string subnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in. However, if the `PrivateIp` object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the `subnetId` is null. ' maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the private IP was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vlanId: description: 'Applicable only if the `PrivateIp` object is being used with a VLAN as part of the Oracle Cloud VMware Solution. The `vlanId` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. See [Vlan](#/en/iaas/latest/Vlan). ' maxLength: 255 minLength: 1 type: string vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC the private IP is assigned to. The VNIC and private IP must be in the same subnet. However, if the `PrivateIp` object is being used with a VLAN as part of the Oracle Cloud VMware Solution, the `vnicId` is null. ' maxLength: 255 minLength: 1 type: string Byoasn: description: Oracle offers the ability to Bring Your Own Autonomous System Number (BYOASN), importing AS Numbers you currently own to Oracle Cloud Infrastructure. A `Byoasn` resource is a record of the imported AS Number and also some associated metadata. The process used to [Bring Your Own ASN](/iaas/Content/Network/Concepts/BYOASN.htm) is explained in the documentation. properties: asn: description: The Autonomous System Number (ASN) you are importing to the Oracle cloud. format: int64 maximum: 4294967294 minimum: 1 type: integer byoipRanges: description: The BYOIP Ranges that has the `Byoasn` as origin. items: $ref: '#/components/schemas/ByoasnByoipRange' type: array compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Byoasn` resource. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The `Byoasn` resource's current state. enum: - UPDATING - ACTIVE - DELETED - FAILED - CREATING type: string timeCreated: description: 'The date and time the `Byoasn` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeUpdated: description: 'The date and time the `Byoasn` resource was last updated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeValidated: description: 'The date and time the `Byoasn` resource was validated, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string validationToken: description: The validation token is an internally-generated ASCII string used in the validation process. See [Importing a Byoasn](/iaas/Content/Network/Concepts/BYOASN.htm) for details. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - asn - lifecycleState - validationToken - timeCreated TunnelPhaseOneDetails: description: IPSec tunnel details specific to ISAKMP phase one. properties: customAuthenticationAlgorithm: description: The proposed custom authentication algorithm. maxLength: 255 minLength: 1 type: string customDhGroup: description: The proposed custom Diffie-Hellman group. maxLength: 255 minLength: 1 type: string customEncryptionAlgorithm: description: The proposed custom encryption algorithm. maxLength: 255 minLength: 1 type: string isCustomPhaseOneConfig: description: 'Indicates whether custom phase one configuration is enabled. If this option is not enabled, default settings are proposed. ' type: boolean isIkeEstablished: description: Indicates whether IKE phase one is established. type: boolean lifetime: description: The total configured lifetime of the IKE security association. format: int64 type: integer negotiatedAuthenticationAlgorithm: description: The negotiated authentication algorithm. maxLength: 255 minLength: 1 type: string negotiatedDhGroup: description: The negotiated Diffie-Hellman group. maxLength: 255 minLength: 1 type: string negotiatedEncryptionAlgorithm: description: The negotiated encryption algorithm. maxLength: 255 minLength: 1 type: string remainingLifetime: description: The remaining lifetime before the key is refreshed. format: int64 type: integer remainingLifetimeLastRetrieved: description: 'The date and time we retrieved the remaining lifetime, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: object BulkDetachPrivateIpsDetails: description: An object used to detatch Secondary IPv4 addresses with a bulk operation. properties: bulkDetachPrivateIpItem: description: 'Secondary IPv4 addresses to detach. ' items: $ref: '#/components/schemas/BulkDetachPrivateIpItem' maxItems: 16 minItems: 1 type: array vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC of which private IPs should be detached. The VNIC and private IPs must be in the same subnet. ' maxLength: 255 minLength: 1 type: string required: - bulkDetachPrivateIpItem UpdateVcnDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isEncrypted: description: 'Indicates whether traffic within the VCN is encrypted. For more information, see [VN Encryption](/iaas/Content/gov-cloud/govinfo.htm#govinfo_topic_LAN-encryption). ' type: boolean isZprOnly: default: false description: 'Indicates whether ZPR Only mode is enforced. ' type: boolean securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object FastConnectProviderService: description: 'A service offering from a supported provider. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). ' properties: bandwithShapeManagement: description: 'Who is responsible for managing the virtual circuit bandwidth. ' enum: - CUSTOMER_MANAGED - PROVIDER_MANAGED - ORACLE_MANAGED type: string customerAsnManagement: description: 'Who is responsible for managing the ASN information for the network at the other end of the connection from Oracle. ' enum: - CUSTOMER_MANAGED - PROVIDER_MANAGED - ORACLE_MANAGED type: string description: description: 'The location of the provider''s website or portal. This portal is where you can get information about the provider service, create a virtual circuit connection from the provider to Oracle Cloud Infrastructure, and retrieve your provider service key for that virtual circuit connection. Example: `https://example.com` ' maxLength: 255 minLength: 1 type: string id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider. ' maxLength: 255 minLength: 1 type: string privatePeeringBgpManagement: description: 'Who is responsible for managing the private peering BGP information. ' enum: - CUSTOMER_MANAGED - PROVIDER_MANAGED - ORACLE_MANAGED type: string providerName: description: 'The name of the provider. ' maxLength: 255 minLength: 1 type: string providerServiceKeyManagement: description: 'Who is responsible for managing the provider service key. ' enum: - CUSTOMER_MANAGED - PROVIDER_MANAGED - ORACLE_MANAGED type: string providerServiceName: description: 'The name of the service offered by the provider. ' maxLength: 255 minLength: 1 type: string publicPeeringBgpManagement: description: 'Who is responsible for managing the public peering BGP information. ' enum: - CUSTOMER_MANAGED - PROVIDER_MANAGED - ORACLE_MANAGED type: string requiredTotalCrossConnects: description: 'Total number of cross-connect or cross-connect groups required for the virtual circuit. ' type: integer supportedVirtualCircuitTypes: description: 'An array of virtual circuit types supported by this service. ' items: enum: - PUBLIC - PRIVATE type: string maximum: 2 minimum: 0 type: array type: description: 'Provider service type. ' enum: - LAYER2 - LAYER3 type: string required: - id - providerName - providerServiceName - type - privatePeeringBgpManagement - publicPeeringBgpManagement - customerAsnManagement - providerServiceKeyManagement - bandwithShapeManagement - requiredTotalCrossConnects UpdateByoipRangeDetails: description: The information used to update a `ByoipRange` resource. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object TunnelConfig: description: "Deprecated. For tunnel information, instead see:\n\n * [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)\n * [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/)\n" properties: ipAddress: description: 'The IP address of Oracle''s VPN headend. Example: `203.0.113.50 ` ' maxLength: 46 minLength: 1 type: string sharedSecret: description: 'The shared secret of the IPSec tunnel. ' maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - ipAddress - sharedSecret RemoveIpv4SubnetCidrDetails: description: Details object for removing an IPv4 prefix from a subnet. properties: ipv4CidrBlock: description: 'This field should only be specified when removing an IPv4 prefix from a subnet''s IPv4 address space. The CIDR must maintain the following rules - a. The CIDR block is valid and correctly formatted. b. The CIDR range is within one of the parent VCN ranges. c. The CIDR range to be removed is already present in the list of ipv4CidrBlocks Example: `10.0.1.0/24` ' maxLength: 32 minLength: 1 type: string required: - ipv4CidrBlock CreatePublicIpPoolDetails: description: The information used to create a public IP pool. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the public IP pool. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId VirtualCircuitBandwidthShape: description: 'An individual bandwidth level for virtual circuits. ' properties: bandwidthInMbps: description: 'The bandwidth in Mbps. Example: `10000` ' type: integer name: description: 'The name of the bandwidth shape. Example: `10 Gbps` ' maxLength: 255 minLength: 1 type: string required: - name UpdateIPSecTunnelEncryptionDomainDetails: description: 'Request to update a multi-encryption domain policy on the IPSec tunnel. There can''t be more than 50 security associations in use at one time. See [Encryption domain for policy-based tunnels](/iaas/Content/Network/Tasks/ipsecencryptiondomains.htm#spi_policy_based_tunnel) for more. ' properties: cpeTrafficSelector: description: Lists IPv4 or IPv6-enabled subnets in your on-premises network. items: type: string minLength: 1 type: array uniqueItems: true oracleTrafficSelector: description: Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy. items: type: string minLength: 1 type: array uniqueItems: true InventoryIpAddressSummary: description: 'Provides the IP address and its corresponding VNIC ID, VNIC name, and DNS hostname. ' properties: dnsHostName: description: The DNS hostname of the resource assigned with the IP address. maxLength: 255 minLength: 1 type: string ipAddress: description: The IP address assigned from a subnet. maxLength: 255 minLength: 1 type: string vnicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. maxLength: 255 minLength: 1 type: string vnicName: description: The name of the VNIC. maxLength: 255 minLength: 1 type: string EgressSecurityRule: description: A rule for allowing outbound IP packets. properties: description: description: 'An optional description of your choice for the rule. ' maxLength: 255 minLength: 1 type: string destination: description: "Conceptually, this is the range of IP addresses that a packet originating from the instance\ncan go to.\n\nAllowed values:\n\n * IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`\n Note that IPv6 addressing is currently supported only in certain regions. See\n [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm).\n\n * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're\n setting up a security list rule for traffic destined for a particular `Service` through\n a service gateway. For example: `oci-phx-objectstorage`.\n" type: string destinationType: default: CIDR_BLOCK description: "Type of destination for the rule. The default is `CIDR_BLOCK`.\n\nAllowed values:\n\n * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.\n\n * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a\n particular `Service` through a service gateway).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK type: string icmpOptions: $ref: '#/components/schemas/IcmpOptions' isStateless: description: 'A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic. ' type: boolean protocol: description: 'The transport protocol. Specify either `all` or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). ' type: string tcpOptions: $ref: '#/components/schemas/TcpOptions' udpOptions: $ref: '#/components/schemas/UdpOptions' required: - destination - protocol CreateByoipRangeDetails: description: The information used to create a `ByoipRange` resource. properties: cidrBlock: description: 'The BYOIP CIDR block. You can assign some or all of it to a public IP pool after it is validated. Example: `10.0.1.0/24` ' maxLength: 18 minLength: 9 type: string compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOIP CIDR block. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipv6CidrBlock: description: 'The BYOIPv6 prefix. You can assign some or all of it to a VCN after it is validated. ' maxLength: 45 minLength: 1 type: string required: - compartmentId UpdateMacsecProperties: description: Properties used to update MACsec settings. properties: encryptionCipher: description: Type of encryption cipher suite to use for the MACsec connection. enum: - AES128_GCM - AES128_GCM_XPN - AES256_GCM - AES256_GCM_XPN type: string x-obmcs-top-level-enum: '#/definitions/MacsecEncryptionCipher' isUnprotectedTrafficAllowed: default: false description: Indicates whether unencrypted traffic is allowed if MACsec Key Agreement protocol (MKA) fails. type: boolean primaryKey: $ref: '#/components/schemas/UpdateMacsecKey' state: description: Indicates whether or not MACsec is enabled. enum: - ENABLED - DISABLED type: string x-obmcs-top-level-enum: '#/definitions/MacsecState' required: - state AddIpv4SubnetCidrDetails: description: Details used when adding an IPv4 prefix to a subnet. properties: ipv4CidrBlock: description: 'The CIDR IP address range of the subnet. The CIDR must maintain the following rules - a. The CIDR block is valid and correctly formatted. b. The new range is within one of the parent VCN ranges. Example: `10.0.1.0/24` ' maxLength: 32 minLength: 1 type: string required: - ipv4CidrBlock CreateIPSecConnectionDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the IPSec connection. maxLength: 255 minLength: 1 type: string cpeId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [Cpe](#/en/iaas/latest/Cpe/) object. maxLength: 255 minLength: 1 type: string cpeLocalIdentifier: description: 'Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier you provide here must correspond to the value for `cpeLocalIdentifierType`. If you don''t provide a value, the `ipAddress` attribute for the [Cpe](#/en/iaas/latest/Cpe/) object specified by `cpeId` is used as the `cpeLocalIdentifier`. For information about why you''d provide this value, see [If Your CPE Is Behind a NAT Device](/iaas/Content/Network/Tasks/overviewIPsec.htm#nat). Example IP address: `10.0.3.3` Example hostname: `cpe.example.com` ' maxLength: 255 minLength: 1 type: string cpeLocalIdentifierType: description: 'The type of identifier for your CPE device. The value you provide here must correspond to the value for `cpeLocalIdentifier`. ' enum: - IP_ADDRESS - HOSTNAME type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string drgId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object staticRoutes: description: 'Static routes to the CPE. A static route''s CIDR must not be a multicast address or class E address. Used for routing a given IPSec tunnel''s traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. For more information, see the important note in [IPSecConnection](#/en/iaas/latest/IPSecConnection/). The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `10.0.1.0/24` Example: `2001:db8::/32` ' items: type: string maxLength: 10 minLength: 1 type: array uniqueItems: true tunnelConfiguration: description: 'Information for creating the individual tunnels in the IPSec connection. You can provide a maximum of 2 `tunnelConfiguration` objects in the array (one for each of the two tunnels). ' items: $ref: '#/components/schemas/CreateIPSecConnectionTunnelDetails' type: array required: - compartmentId - drgId - cpeId BulkUpdateIpv6sDetails: description: Address details to update for a Secondary IPv6 object. properties: bulkUpdateIpv6sItem: description: 'A secondary IPv6 address to update. ' items: $ref: '#/components/schemas/BulkUpdateIpv6sItem' maxItems: 16 minItems: 1 type: array vnicId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to move the IPv6s to. \nThe VNIC and IPv6s must be in the same subnet.\n" maxLength: 255 minLength: 1 type: string required: - bulkUpdateIpv6sItem CreateCpeDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the CPE. maxLength: 255 minLength: 1 type: string cpeDeviceShapeId: description: "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device type. You can provide\na value if you want to later generate CPE device configuration content for IPSec connections\nthat use this CPE. You can also call [UpdateCpe](#/en/iaas/latest/Cpe/UpdateCpe) later to\nprovide a value. For a list of possible values, see\n[ListCpeDeviceShapes](#/en/iaas/latest/CpeDeviceShapeSummary/ListCpeDeviceShapes).\n\nFor more information about generating CPE device configuration content, see:\n\n * [GetCpeDeviceConfigContent](#/en/iaas/latest/Cpe/GetCpeDeviceConfigContent)\n * [GetIpsecCpeDeviceConfigContent](#/en/iaas/latest/IPSecConnection/GetIpsecCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfigContent](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfigContent)\n * [GetTunnelCpeDeviceConfig](#/en/iaas/latest/TunnelCpeDeviceConfig/GetTunnelCpeDeviceConfig)\n" maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ipAddress: description: 'The public IP address of the on-premises router. Example: `203.0.113.2` ' maxLength: 46 minLength: 1 type: string isPrivate: default: false description: 'Indicates whether this CPE is of type `private` or not. ' type: boolean required: - compartmentId - ipAddress CreateSecurityListDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the security list. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string egressSecurityRules: description: Rules for allowing egress IP packets. items: $ref: '#/components/schemas/EgressSecurityRule' type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ingressSecurityRules: description: Rules for allowing ingress IP packets. items: $ref: '#/components/schemas/IngressSecurityRule' type: array vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the security list belongs to. maxLength: 255 minLength: 1 type: string required: - compartmentId - egressSecurityRules - ingressSecurityRules - vcnId VcnTopology: allOf: - $ref: '#/components/schemas/Topology' - discriminator: propertyName: VCN properties: vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN for which the topology is generated. maxLength: 255 minLength: 1 type: string description: "Defines the representation of a virtual network topology for a VCN. \nSee [Network Visualizer Documentation](/iaas/Content/Network/Concepts/network_visualizer.htm) for more information, including\nconventions and pictures of symbols.\n" ByoasnSummary: description: Information about a `Byoasn` resource. properties: asn: description: The Autonomous System Number (ASN) you are importing to the Oracle cloud. format: int64 maximum: 4294967294 minimum: 1 type: integer compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `Byoasn` resource. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. maxLength: 255 minLength: 1 type: string lifecycleState: description: The `Byoasn` resource's current state. type: string x-obmcs-enumref: '#/definitions/Byoasn/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object timeCreated: description: 'The date and time the `Byoasn` resource was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - asn - lifecycleState DrgAttachmentNetworkUpdateDetails: discriminator: propertyName: type properties: type: enum: - VCN type: string required: - type CreateVirtualCircuitDetails: properties: bandwidthShapeName: description: 'The provisioned data rate of the connection. To get a list of the available bandwidth levels (that is, shapes), see [ListFastConnectProviderServiceVirtualCircuitBandwidthShapes](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderVirtualCircuitBandwidthShapes). Example: `10 Gbps` ' type: string bgpAdminState: description: 'Set to `ENABLED` (the default) to activate the BGP session of the virtual circuit, set to `DISABLED` to deactivate the virtual circuit. ' enum: - ENABLED - DISABLED type: string compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the virtual circuit. ' maxLength: 255 minLength: 1 type: string crossConnectMappings: description: 'Create a `CrossConnectMapping` for each cross-connect or cross-connect group this virtual circuit will run on. ' items: $ref: '#/components/schemas/CrossConnectMapping' maximum: 2 minimum: 0 type: array customerBgpAsn: description: 'Your BGP ASN (either public or private). Provide this value only if there''s a BGP session that goes from your edge router to Oracle. Otherwise, leave this empty or null. ' type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object gatewayId: description: 'For private virtual circuits only. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [dynamic routing gateway (DRG)](#/en/iaas/latest/Drg) that this virtual circuit uses. ' maxLength: 255 minLength: 1 type: string ipMtu: description: The layer 3 IP MTU to use with this virtual circuit. enum: - MTU_1500 - MTU_9000 type: string x-obmcs-top-level-enum: '#/definitions/VirtualCircuitIpMtu' isBfdEnabled: default: false description: 'Set to `true` to enable BFD for IPv4 BGP peering, or set to `false` to disable BFD. If this is not set, the default is `false`. ' type: boolean isTransportMode: default: false description: 'Set to `true` for the virtual circuit to carry only encrypted traffic, or set to `false` for the virtual circuit to carry unencrypted traffic. If this is not set, the default is `false`. ' type: boolean providerName: description: 'Deprecated. Instead use `providerServiceId`. To get a list of the provider names, see [ListFastConnectProviderServices](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderServices). ' maxLength: 255 minLength: 1 type: string providerServiceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service offered by the provider (if you''re connecting via a provider). To get a list of the available service offerings, see [ListFastConnectProviderServices](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderServices). ' maxLength: 255 minLength: 1 type: string providerServiceKeyName: description: 'The service key name or activation key offered by the provider (if the customer is connecting via a provider). ' maxLength: 1000 minLength: 1 type: string providerServiceName: description: 'Deprecated. Instead use `providerServiceId`. To get a list of the provider names, see [ListFastConnectProviderServices](#/en/iaas/latest/FastConnectProviderService/ListFastConnectProviderServices). ' maxLength: 255 minLength: 1 type: string publicPrefixes: description: 'For a public virtual circuit. The public IP prefixes (CIDRs) the customer wants to advertise across the connection. ' items: $ref: '#/components/schemas/CreateVirtualCircuitPublicPrefixDetails' maximum: 50 minimum: 0 type: array region: description: 'The Oracle Cloud Infrastructure region where this virtual circuit is located. Example: `phx` ' maxLength: 255 minLength: 1 type: string routingPolicy: description: 'The routing policy sets how routing information about the Oracle cloud is shared over a public virtual circuit. Policies available are: `ORACLE_SERVICE_NETWORK`, `REGIONAL`, `MARKET_LEVEL`, and `GLOBAL`. See [Route Filtering](/iaas/Content/Network/Concepts/routingonprem.htm#route_filtering) for details. By default, routing information is shared for all routes in the same market. ' items: enum: - ORACLE_SERVICE_NETWORK - REGIONAL - MARKET_LEVEL - GLOBAL type: string maxItems: 16 type: array type: description: 'The type of IP addresses used in this virtual circuit. PRIVATE means [RFC 1918](https://tools.ietf.org/html/rfc1918) addresses (10.0.0.0/8, 172.16/12, and 192.168/16). ' enum: - PUBLIC - PRIVATE type: string required: - compartmentId - type SecurityList: description: 'A set of virtual firewall rules for your VCN. Security lists are configured at the subnet level, but the rules are applied to the ingress and egress traffic for the individual instances in the subnet. The rules can be stateful or stateless. For more information, see [Security Lists](/iaas/Content/Network/Concepts/securitylists.htm). **Note:** Compare security lists to [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/)s, which let you apply a set of security rules to a *specific set of VNICs* instead of an entire subnet. Oracle recommends using network security groups instead of security lists, although you can use either or both together. **Important:** Oracle Cloud Infrastructure Compute service images automatically include firewall rules (for example, Linux iptables, Windows firewall). If there are issues with some type of access to an instance, make sure both the security lists associated with the instance''s subnet and the instance''s firewall rules are set correctly. To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the security list. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string egressSecurityRules: description: Rules for allowing egress IP packets. items: $ref: '#/components/schemas/EgressSecurityRule' type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The security list's Oracle Cloud ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string ingressSecurityRules: description: Rules for allowing ingress IP packets. items: $ref: '#/components/schemas/IngressSecurityRule' type: array lifecycleState: description: The security list's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string timeCreated: description: 'The date and time the security list was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the security list belongs to. maxLength: 255 minLength: 1 type: string required: - compartmentId - displayName - egressSecurityRules - id - ingressSecurityRules - lifecycleState - timeCreated - vcnId x-example: "{\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"MyPrivateSubnetSecurityList\",\n \"egressSecurityRules\" : [{\n \"destination\" : \"10.0.2.0/24\",\n \"protocol\" : \"6\",\n \"tcpOptions\" : {\n \"destinationPortRange\" : {\n \"max\" : 1521,\n \"min\" : 1521\n }\n }\n }],\n \"id\" : \"ocid1.securitylist.oc1.phx.<unique_ID>\",\n \"ingressSecurityRules\" : [{\n \"protocol\" : \"6\",\n \"source\" : \"10.0.1.0/24\",\n \"tcpOptions\" : {\n \"destinationPortRange\" : {\n \"max\" : 1521,\n \"min\" : 1521\n }\n }\n },{\n \"protocol\" : \"6\",\n \"source\" : \"10.0.2.0/24\",\n \"tcpOptions\" : {\n \"destinationPortRange\" : {\n \"max\" : 1521,\n \"min\" : 1521\n }\n }\n }],\n \"lifecycleState\" : \"AVAILABLE\",\n \"timeCreated\" : \"2016-12-14T21:02:46.357Z\",\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\"\n}\n" UdpOptions: description: 'Optional and valid only for UDP. Use to specify particular destination ports for UDP rules. If you specify UDP as the protocol but omit this object, then all destination ports are allowed. ' properties: destinationPortRange: $ref: '#/components/schemas/PortRange' sourcePortRange: $ref: '#/components/schemas/PortRange' ChangePublicIpCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the public IP to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId ConnectRemotePeeringConnectionsDetails: description: Information about the other remote peering connection (RPC). properties: peerId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the RPC you want to peer with. maxLength: 255 minLength: 1 type: string peerRegionName: description: 'The name of the region that contains the RPC you want to peer with. Example: `us-ashburn-1` ' maxLength: 255 minLength: 1 type: string required: - peerId - peerRegionName BulkDetachPrivateIpItem: description: An object used to detatch secondary private IPv4 addresses with a bulk operation. properties: privateIpId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secondary Private IP. ' maxLength: 255 minLength: 1 type: string required: - privateIpId ModifyIpv4SubnetCidrDetails: description: Details object for updating the specified Ipv4 CIDR block of a Subnet. properties: ipv4CidrBlock: description: 'The Ipv4 CIDR IP address to update. ' maxLength: 18 minLength: 9 type: string updatedIpv4CidrBlock: description: 'The new Ipv4 CIDR IP address. ' maxLength: 18 minLength: 9 type: string required: - ipv4CidrBlock - updatedIpv4CidrBlock UpdatePublicIpDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object privateIpId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP to assign the public IP to. * If the public IP is already assigned to a different private IP, it will be unassigned and then reassigned to the specified private IP. * If you set this field to an empty string, the public IP will be unassigned from the private IP it is currently assigned to. ' maxLength: 255 minLength: 0 type: string ChangeCpeCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the CPE object to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId IPSecConnectionDeviceStatus: description: 'Deprecated. For tunnel information, instead see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPSec connection. maxLength: 255 minLength: 1 type: string id: description: The IPSec connection's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string tunnels: description: Two [TunnelStatus](#/en/iaas/latest/TunnelStatus/) objects. items: $ref: '#/components/schemas/TunnelStatus' type: array required: - compartmentId - id ChangeCrossConnectGroupCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the cross-connect group to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId BulkCreateIpv6sDetails: description: Details needed to create secondary IPv6 addresses with a bulk operation. properties: bulkCreateIpv6sItem: description: 'A secondary IPv6 address to assign. ' items: $ref: '#/components/schemas/BulkCreateIpv6sItem' maxItems: 16 minItems: 1 type: array subnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the IPv6s are to be drawn. The IP addresses, *if supplied*, must be valid for the given subnet, only valid for reserved IPs currently. ' maxLength: 255 minLength: 1 type: string vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the IPv6s to. The IPv6s will be in the VNIC''s subnet. ' maxLength: 255 minLength: 1 type: string required: - bulkCreateIpv6sItem AllowedPhaseTwoParameters: description: Allowed phase two parameters. properties: authenticationAlgorithms: description: Allowed phase two authentication algorithms. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array encryptionAlgorithms: description: Allowed phase two encryption algorithms. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array pfsDhGroups: description: Allowed perfect forward secrecy Diffie-Hellman groups. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array UpdateRemotePeeringConnectionDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object AddDrgRouteRulesDetails: description: 'Details used in a request to add static routes to a DRG route table. ' properties: routeRules: description: 'The collection of static rules used to insert routes into the DRG route table. ' items: $ref: '#/components/schemas/AddDrgRouteRuleDetails' maxItems: 100 minItems: 1 type: array TopologyEntityRelationship: description: Defines the relationship between Virtual Network topology entities. discriminator: propertyName: type properties: id1: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the first entity in the relationship. type: string id2: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the second entity in the relationship. type: string type: description: The type of relationship between the entities. enum: - CONTAINS - ASSOCIATED_WITH - ROUTES_TO type: string required: - id1 - id2 - type RemoveDrgRouteRulesDetails: description: 'Details used in a request to remove static routes from a DRG route table. ' properties: routeRuleIds: description: 'The Oracle-assigned ID of each DRG route rule to be deleted. ' items: type: string maxItems: 100 minItems: 1 type: array CpeDeviceConfigAnswer: description: 'An individual answer to a CPE device question. The answers correlate to the questions that are specific to the CPE device type (see the `parameters` attribute of [CpeDeviceShapeDetail](#/en/iaas/latest/CpeDeviceShapeDetail/)). ' properties: key: description: 'A string that identifies the question to be answered. See the `key` attribute in [CpeDeviceConfigQuestion](#/en/iaas/latest/datatypes/CpeDeviceConfigQuestion). ' maxLength: 255 minLength: 1 type: string value: description: The answer to the question. type: string IPSecConnectionDeviceConfig: description: "Deprecated. For tunnel information, instead see:\n\n * [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)\n * [IPSecConnectionTunnelSharedSecret](#/en/iaas/latest/IPSecConnectionTunnelSharedSecret/)\n" properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPSec connection. maxLength: 255 minLength: 1 type: string id: description: The IPSec connection's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string timeCreated: description: The date and time the IPSec connection was created. format: date-time type: string tunnels: description: Two [TunnelConfig](#/en/iaas/latest/TunnelConfig/) objects. items: $ref: '#/components/schemas/TunnelConfig' type: array required: - compartmentId - id x-example: "{\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"id\" : \"ocid1.ipsecconnection.oc1.phx.<unique_ID>\",\n \"timeCreated\" : \"2016-12-16T22:43:25.588Z\",\n \"tunnels\" : [{\n \"ipAddress\" : \"203.0.113.50\",\n \"sharedSecret\" : \"<example_shared_secret>\",\n \"timeCreated\" : \"2016-12-16T22:43:31.826Z\"\n }, {\n \"ipAddress\" : \"203.0.113.52\",\n \"sharedSecret\" : \"<example_shared_secret>\",\n \"timeCreated\" : \"2016-12-16T22:43:31.861Z\"\n }, {\n \"ipAddress\" : \"203.0.113.51\",\n \"sharedSecret\" : \"<example_shared_secret>\",\n \"timeCreated\" : \"2016-12-16T22:43:31.844Z\"\n }]\n}\n" UpgradeStatus: description: 'The upgrade status of a DRG. ' properties: drgId: description: 'The `drgId` of the upgraded DRG. ' type: string status: description: 'The current upgrade status of the DRG attachment. ' enum: - NOT_UPGRADED - IN_PROGRESS - UPGRADED type: string upgradedConnections: description: 'The number of upgraded connections. ' type: string required: - drgId - status - upgradedConnections TcpOptions: description: 'Optional and valid only for TCP. Use to specify particular destination ports for TCP rules. If you specify TCP as the protocol but omit this object, then all destination ports are allowed. ' properties: destinationPortRange: $ref: '#/components/schemas/PortRange' sourcePortRange: $ref: '#/components/schemas/PortRange' ChangeCrossConnectCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the cross-connect to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId UpdateIPSecTunnelBgpSessionDetails: properties: customerBgpAsn: description: 'The BGP ASN of the network on the CPE end of the BGP session. Can be a 2-byte or 4-byte ASN. Uses "asplain" format. If you are switching the tunnel from using BGP dynamic routing to static routing, the `customerBgpAsn` must be null. Example: `12345` (2-byte) or `1587232876` (4-byte) ' maxLength: 10 minLength: 1 type: string customerInterfaceIp: description: 'The IP address for the CPE end of the inside tunnel interface. If the tunnel''s `routing` attribute is set to `BGP` (see [UpdateIPSecConnectionTunnelDetails](#/en/iaas/latest/datatypes/UpdateIPSecConnectionTunnelDetails)), this IP address is used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. The value must be a /30 or /31. If you are switching the tunnel from using BGP dynamic routing to static routing and want to remove the value for `customerInterfaceIp`, you can set the value to an empty string. Example: `10.0.0.5/31` ' maxLength: 18 type: string customerInterfaceIpv6: description: 'The IPv6 address for the CPE end of the inside tunnel interface. This IP address is optional. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. Only subnet masks from /64 up to /127 are allowed. Example: `2001:db8::1/64` ' maxLength: 50 type: string oracleInterfaceIp: description: 'The IP address for the Oracle end of the inside tunnel interface. If the tunnel''s `routing` attribute is set to `BGP` (see [UpdateIPSecConnectionTunnelDetails](#/en/iaas/latest/datatypes/UpdateIPSecConnectionTunnelDetails)), this IP address is used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. The value must be a /30 or /31. If you are switching the tunnel from using BGP dynamic routing to static routing and want to remove the value for `oracleInterfaceIp`, you can set the value to an empty string. Example: `10.0.0.4/31` ' maxLength: 18 type: string oracleInterfaceIpv6: description: 'The IPv6 address for the Oracle end of the inside tunnel interface. This IP address is optional. If the tunnel''s `routing` attribute is set to `BGP` (see [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/)), this IP address is used for the tunnel''s BGP session. If `routing` is instead set to `STATIC`, you can set this IP address to troubleshoot or monitor the tunnel. Only subnet masks from /64 up to /127 are allowed. Example: `2001:db8::1/64` ' maxLength: 50 type: string ByoipRangeCollection: description: The results returned by a `ListByoipRange` operation. properties: items: description: A list of `ByoipRange` resource summaries. items: $ref: '#/components/schemas/ByoipRangeSummary' type: array required: - items type: object ByoipRangeOriginAsn: description: Information about the origin asn. properties: asPathPrependLength: default: 1 description: The as path prepend length. minimum: 1 type: integer asn: description: The Autonomous System Number (ASN) you are importing to the Oracle cloud. format: int64 maximum: 4294967294 minimum: 1 type: integer byoasnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. maxLength: 255 minLength: 1 type: string required: - asn type: object CreateDhcpDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the set of DHCP options. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object options: description: A set of DHCP options. items: $ref: '#/components/schemas/DhcpOption' type: array uniqueItems: true vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the set of DHCP options belongs to. maxLength: 255 minLength: 1 type: string required: - compartmentId - options - vcnId AddVcnCidrDetails: description: Details used to add a CIDR block to a VCN. properties: cidrBlock: description: 'The CIDR block to add. ' maxLength: 18 minLength: 9 type: string required: - cidrBlock ChangeVcnCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the VCN to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId UpdateMacsecKey: description: An object defining the OCID of the Secret held in Vault that represent the MACsec key. properties: connectivityAssociationKeySecretId: description: 'Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key (CAK) of this MACsec key. ' maxLength: 255 minLength: 1 type: string connectivityAssociationKeySecretVersion: description: The secret version of the connectivityAssociationKey secret in Vault. format: int64 maximum: 65535 minimum: 1 type: integer connectivityAssociationNameSecretId: description: 'Secret [OCID](/iaas/Content/General/Concepts/identifiers.htm) containing the Connectivity Association Key Name (CKN) of this MACsec key. ' maxLength: 255 minLength: 1 type: string connectivityAssociationNameSecretVersion: description: The secret version of the connectivity association name secret in Vault. format: int64 maximum: 65535 minimum: 1 type: integer required: - connectivityAssociationNameSecretId - connectivityAssociationNameSecretVersion - connectivityAssociationKeySecretId - connectivityAssociationKeySecretVersion DrgRouteDistributionMatchCriteria: description: 'The match criteria in a route distribution statement. The match criteria outlines which routes should be imported or exported. ' discriminator: propertyName: matchType properties: matchType: description: 'The type of the match criteria for a route distribution statement. ' enum: - DRG_ATTACHMENT_TYPE - DRG_ATTACHMENT_ID - MATCH_ALL type: string required: - matchType ByoipRangeVcnIpv6AllocationSummary: description: 'A summary of IPv6 prefix subranges currently allocated to a VCN. ' properties: byoipRangeId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. maxLength: 255 minLength: 1 type: string compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the `ByoipRange`. ' maxLength: 255 minLength: 1 type: string ipv6CidrBlock: description: 'The BYOIPv6 prefix range or subrange allocated to a VCN. This could be all or part of a BYOIPv6 prefix. Each VCN allocation must be /64 or larger. ' maxLength: 45 minLength: 1 type: string vcnId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Vcn` resource to which the ByoipRange belongs. ' maxLength: 255 minLength: 1 type: string GetPublicIpByIpAddressDetails: description: 'IP address of the public IP. ' properties: ipAddress: description: 'The public IP address. Example: 203.0.113.2 ' maxLength: 32 minLength: 1 type: string required: - ipAddress PublicIpPoolCollection: description: Results of a `ListPublicIpPool` operation. properties: items: description: A list of public IP pool summaries. items: $ref: '#/components/schemas/PublicIpPoolSummary' type: array required: - items type: object VtapCaptureFilterRuleDetails: description: 'This resource contains the rules governing what traffic a VTAP mirrors. ' properties: destinationCidr: description: 'Traffic sent to this CIDR block through the VTAP source will be mirrored to the VTAP target. ' type: string icmpOptions: $ref: '#/components/schemas/IcmpOptions' protocol: description: "The transport protocol used in the filter. If do not choose a protocol, all protocols will be used in the filter.\nSupported options are:\n * 1 = ICMP\n * 6 = TCP\n * 17 = UDP\n" type: string ruleAction: description: 'Include or exclude packets meeting this definition from mirrored traffic. ' enum: - INCLUDE - EXCLUDE type: string sourceCidr: description: 'Traffic from this CIDR block to the VTAP source will be mirrored to the VTAP target. ' type: string tcpOptions: $ref: '#/components/schemas/TcpOptions' trafficDirection: description: 'The traffic direction the VTAP is configured to mirror. ' enum: - INGRESS - EGRESS type: string udpOptions: $ref: '#/components/schemas/UdpOptions' required: - trafficDirection DrgRedundancyStatus: description: 'The redundancy status of the DRG. For more information, see [Redundancy Remedies](/iaas/Content/Network/Troubleshoot/drgredundancy.htm). ' properties: id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. maxLength: 255 minLength: 1 type: string status: description: The redundancy status of the DRG. enum: - NOT_AVAILABLE - REDUNDANT - NOT_REDUNDANT_SINGLE_IPSEC - NOT_REDUNDANT_SINGLE_VIRTUALCIRCUIT - NOT_REDUNDANT_MULTIPLE_IPSECS - NOT_REDUNDANT_MULTIPLE_VIRTUALCIRCUITS - NOT_REDUNDANT_MIX_CONNECTIONS - NOT_REDUNDANT_NO_CONNECTION type: string AddNetworkSecurityGroupSecurityRulesDetails: properties: securityRules: description: 'An array of security rules to add to the NSG. You can add up to 25 rules in a single `AddNetworkSecurityGroupSecurityRules` operation. Adding more than 25 rules requires multiple operations. ' items: $ref: '#/components/schemas/AddSecurityRuleDetails' maxItems: 25 minItems: 1 type: array InventorySubnetCidrBlockSummary: description: 'Lists CIDRs and utilization within a subnet. ' properties: ipCidrBlock: description: The CIDR Prefix within a VCN. maxLength: 45 minLength: 1 type: string utilization: description: The CIDR utilization of a VCN. format: float maximum: 100.0 minimum: 0.0 type: number ChangeNatGatewayCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the NAT gateway to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId Topology: description: Defines the representation of a virtual network topology. discriminator: propertyName: type properties: entities: description: Lists entities comprising the virtual network topology. items: type: object type: array limitedEntities: description: 'Lists entities that are limited during ingestion. The values for the items in the list are the entity type names of the limitedEntities. Example: `vcn` ' items: type: string maxItems: 100 type: array relationships: description: Lists relationships between entities in the virtual network topology. items: $ref: '#/components/schemas/TopologyEntityRelationship' type: array timeCreated: description: Records when the virtual network topology was created, in [RFC3339](https://tools.ietf.org/html/rfc3339) format for date and time. format: date-time type: string type: description: Type of the topology object. enum: - NETWORKING - VCN - SUBNET - PATH type: string required: - type - entities - relationships - limitedEntities - timeCreated ChangeServiceGatewayCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the service gateway to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId AddPublicIpPoolCapacityDetails: description: The information used to add capacity to an IP pool. properties: byoipRangeId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource to which the CIDR block belongs. maxLength: 255 minLength: 1 type: string cidrBlock: description: 'The CIDR block to add to the public IP pool. It could be all of the CIDR block identified in `byoipRangeId`, or a subrange. Example: `10.0.1.0/24` ' maxLength: 18 minLength: 9 type: string required: - byoipRangeId - cidrBlock CreateNatGatewayDetails: properties: blockTraffic: default: false description: 'Whether the NAT gateway blocks traffic through it. The default is `false`. Example: `true` ' type: boolean compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the NAT gateway. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object publicIpId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP address associated with the NAT gateway. ' maxLength: 255 minLength: 1 type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table used by the NAT gateway. If you don''t specify a route table here, the NAT gateway is created without an associated route table. The Networking service does NOT automatically associate the attached VCN''s default route table with the NAT gateway. ' maxLength: 255 minLength: 1 type: string vcnId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the gateway belongs to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId - vcnId VirtualCircuitRedundancyMetadata: description: 'This resource provides redundancy level details for the virtual circuit. For more about redundancy, see [FastConnect Redundancy Best Practices](/iaas/Content/Network/Concepts/fastconnectresiliency.htm). ' properties: configuredRedundancyLevel: description: The configured redundancy level of the virtual circuit. enum: - DEVICE - POP - REGION - NON_REDUNDANT - PENDING type: string ipv4bgpSessionRedundancyStatus: description: 'Indicates if the configured level is met for IPv4 BGP redundancy. ' enum: - CONFIGURATION_MATCH - CONFIGURATION_MISMATCH - NOT_MET_SLA type: string ipv6bgpSessionRedundancyStatus: description: 'Indicates if the configured level is met for IPv6 BGP redundancy. ' enum: - CONFIGURATION_MATCH - CONFIGURATION_MISMATCH - NOT_MET_SLA type: string DrgRouteDistributionStatement: description: 'A single statement within a route distribution. All match criteria in a statement must be met for the action to take place. ' properties: action: description: '`ACCEPT` indicates the route should be imported or exported as-is. ' enum: - ACCEPT type: string id: description: 'The Oracle-assigned ID of the route distribution statement. ' maxLength: 255 minLength: 1 type: string matchCriteria: description: 'The action is applied only if all of the match criteria is met. If there are no match criteria in a statement, any input is considered a match and the action is applied. ' items: $ref: '#/components/schemas/DrgRouteDistributionMatchCriteria' maxItems: 1 minItems: 0 type: array priority: description: 'This field specifies the priority of each statement in a route distribution. Priorities must be unique within a particular route distribution. The priority will be represented as a number between 0 and 65535 where a lower number indicates a higher priority. When a route is processed, statements are applied in the order defined by their priority. The first matching rule dictates the action that will be taken on the route. ' maximum: 65535 minimum: 1 type: integer required: - matchCriteria - action - priority - id RouteTable: description: 'A collection of `RouteRule` objects, which are used to route packets based on destination IP to a particular network entity. For more information, see [Overview of the Networking Service](/iaas/Content/Network/Concepts/overview.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the route table. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The route table's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string lifecycleState: description: The route table's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string routeRules: description: 'The collection of rules for routing destination IPs to network devices. ' items: $ref: '#/components/schemas/RouteRule' type: array timeCreated: description: 'The date and time the route table was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the route table list belongs to. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - routeRules - lifecycleState - vcnId x-example: "{\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"MyRouteTable\",\n \"id\" : \"ocid1.routetable.oc1.phx.<unique_ID>\",\n \"lifecycleState\" : \"AVAILABLE\",\n \"routeRules\" : [{\n \"cidrBlock\" : \"10.0.3.0/24\",\n \"networkEntityId\" : \"ocid1.internetgateway.oc1.phx.<unique_ID>\"\n }],\n \"timeCreated\" : \"2016-12-14T20:50:04.956Z\",\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\"\n}\n" DeleteVirtualCircuitPublicPrefixDetails: properties: cidrBlock: description: 'An individual public IP prefix (CIDR) to remove from the public virtual circuit. ' maxLength: 50 minLength: 4 type: string required: - cidrBlock UpdateDrgRouteDistributionStatementDetails: description: 'Route distribution statements to update in the route distribution. ' properties: id: description: 'The Oracle-assigned ID of each route distribution statement to be updated. ' maxLength: 255 minLength: 1 type: string matchCriteria: description: 'The action is applied only if all of the match criteria is met. ' items: $ref: '#/components/schemas/DrgRouteDistributionMatchCriteria' maxItems: 1 minItems: 0 type: array priority: description: 'The priority of the statement you''d like to update. ' maximum: 65535 minimum: 1 type: integer required: - id IpInventoryCidrUtilizationCollection: description: The IP Inventory CIDR utilization details of a subnet. properties: compartmentId: description: 'Compartment of the subnet. ' maxLength: 255 minLength: 1 type: string count: description: Specifies the count for the number of results for the response. format: int32 type: integer ipInventoryCidrUtilizationSummary: description: 'Lists ''IpInventoryCidrUtilizationSummary` object. ' items: $ref: '#/components/schemas/IpInventoryCidrUtilizationSummary' type: array lastUpdatedTimestamp: description: 'The Timestamp of the latest update from the database in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string message: description: Indicates the status of the data. maxLength: 255 minLength: 1 type: string IPSecConnection: description: 'A connection between a DRG and CPE. This connection consists of multiple IPSec tunnels. Creating this connection is one of the steps required when setting up a Site-to-Site VPN. **Important:** Each tunnel in an IPSec connection can use either static routing or BGP dynamic routing (see the [IPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/) object''s `routing` attribute). Originally only static routing was supported and every IPSec connection was required to have at least one static route configured. To maintain backward compatibility in the API when support for BPG dynamic routing was introduced, the API accepts an empty list of static routes if you configure both of the IPSec tunnels to use BGP dynamic routing. If you switch a tunnel''s routing from `BGP` to `STATIC`, you must first ensure that the IPSec connection is configured with at least one valid CIDR block static route. Oracle uses the IPSec connection''s static routes when routing a tunnel''s traffic *only* if that tunnel''s `routing` attribute = `STATIC`. Otherwise the static routes are ignored. For more information about the workflow for setting up an IPSec connection, see [Site-to-Site VPN Overview](/iaas/Content/Network/Tasks/overviewIPsec.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the IPSec connection. maxLength: 255 minLength: 1 type: string cpeId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [Cpe](#/en/iaas/latest/Cpe/) object. maxLength: 255 minLength: 1 type: string cpeLocalIdentifier: description: 'Your identifier for your CPE device. Can be either an IP address or a hostname (specifically, the fully qualified domain name (FQDN)). The type of identifier here must correspond to the value for `cpeLocalIdentifierType`. If you don''t provide a value when creating the IPSec connection, the `ipAddress` attribute for the [Cpe](#/en/iaas/latest/Cpe/) object specified by `cpeId` is used as the `cpeLocalIdentifier`. For information about why you''d provide this value, see [If Your CPE Is Behind a NAT Device](/iaas/Content/Network/Tasks/overviewIPsec.htm#nat). Example IP address: `10.0.3.3` Example hostname: `cpe.example.com` ' maxLength: 255 minLength: 1 type: string cpeLocalIdentifierType: description: 'The type of identifier for your CPE device. The value here must correspond to the value for `cpeLocalIdentifier`. ' enum: - IP_ADDRESS - HOSTNAME type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string drgId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The IPSec connection's Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). maxLength: 255 minLength: 1 type: string lifecycleState: description: The IPSec connection's current state. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string staticRoutes: description: 'Static routes to the CPE. The CIDR must not be a multicast address or class E address. Used for routing a given IPSec tunnel''s traffic only if the tunnel is using static routing. If you configure at least one tunnel to use static routing, then you must provide at least one valid static route. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. The CIDR can be either IPv4 or IPv6. IPv6 addressing is supported for all commercial and government regions. See [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `10.0.1.0/24` Example: `2001:db8::/32` ' items: maxLength: 10 type: string type: array uniqueItems: true timeCreated: description: 'The date and time the IPSec connection was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string transportType: default: INTERNET description: 'The transport type used for the IPSec connection. ' enum: - INTERNET - FASTCONNECT type: string required: - compartmentId - id - drgId - cpeId - lifecycleState UpdateCrossConnectGroupDetails: properties: customerReferenceName: description: 'A reference name or identifier for the physical fiber connection this cross-connect group uses. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object macsecProperties: $ref: '#/components/schemas/UpdateMacsecProperties' UpdateByoasnDetails: description: The information used to update a `Byoasn` resource. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object UpdateRouteTableDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object routeRules: description: 'The collection of rules used for routing destination IPs to network devices. ' items: $ref: '#/components/schemas/RouteRule' type: array BulkDeleteIpv6sDetails: description: A secondary IPv6 address bulk deletion object. properties: bulkDeleteIpv6sItem: description: 'An IPv6 address to delete. ' items: $ref: '#/components/schemas/BulkDeleteIpv6sItem' maxItems: 16 minItems: 1 type: array subnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the IPv6s addresses are deleted. ' maxLength: 255 minLength: 1 type: string vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the IPv6s to. The IPv6 will be in the VNIC''s subnet. ' maxLength: 255 minLength: 1 type: string required: - bulkDeleteIpv6sItem CreateVlanDetails: properties: availabilityDomain: description: 'The availability domain of the VLAN. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string cidrBlock: description: 'The range of IPv4 addresses that will be used for layer 3 communication with hosts outside the VLAN. The CIDR must maintain the following rules - 1. The CIDR block is valid and correctly formatted. 2. The new range is within one of the parent VCN ranges. Example: `192.0.2.0/24` ' maxLength: 32 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the VLAN. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object nsgIds: description: 'A list of the OCIDs of the network security groups (NSGs) to add all VNICs in the VLAN to. For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the VLAN will use. If you don''t provide a value, the VLAN uses the VCN''s default route table. ' maxLength: 255 minLength: 1 type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN to contain the VLAN. maxLength: 255 minLength: 1 type: string vlanTag: description: 'The IEEE 802.1Q VLAN tag for this VLAN. The value must be unique across all VLANs in the VCN. If you don''t provide a value, Oracle assigns one. You cannot change the value later. VLAN tag 0 is reserved for use by Oracle. ' format: int32 maximum: 4094 minimum: 1 type: integer required: - availabilityDomain - compartmentId - cidrBlock - vcnId ServiceIdResponseDetails: properties: serviceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the service. ' maxLength: 255 minLength: 1 type: string serviceName: description: The name of the service. maxLength: 255 minLength: 1 type: string required: - serviceId - serviceName EncryptionDomainConfig: description: Configuration information used by the encryption domain policy. properties: cpeTrafficSelector: description: Lists IPv4 or IPv6-enabled subnets in your on-premises network. items: type: string type: array uniqueItems: true oracleTrafficSelector: description: Lists IPv4 or IPv6-enabled subnets in your Oracle tenancy. items: type: string type: array uniqueItems: true AddVcnIpv6CidrDetails: description: Details used when adding a ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or a BYOIPv6 prefix. You can add only one of these per request. properties: byoipv6CidrDetail: $ref: '#/components/schemas/Byoipv6CidrDetails' ipv6PrivateCidrBlock: description: 'This field is not required and should only be specified if a ULA or private IPv6 prefix is desired for VCN''s private IP address space. See[IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123::/48` or `fd00:1000:0:1::/64` ' maxLength: 45 minLength: 1 type: string isOracleGuaAllocationEnabled: default: true description: 'Indicates whether Oracle will allocate an IPv6 GUA. Only one prefix of /56 size can be allocated by Oracle as a GUA. ' type: boolean BulkCreatePrivateIpItem: description: An object used to create secondary private IPv4 addresses in a bulk operation. properties: cidrPrefixLength: default: 32 description: "An optional field that when combined with the ipAddress field, will be used to allocate secondary IPv4 CIDRs.\nThe CIDR range created by this combination must be within the subnet's CIDR \nand the CIDR range should not collide with any existing IPv4 address allocation.\nThe VNIC ID specified in the request object should not already been assigned more than the max IPv4 addresses.\nIf you don't specify a value, this option will be ignored.\n\nExample: 18\n" maximum: 32 minimum: 18 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostnameLabel: description: "The hostname for the private IP. Used for DNS. The value\nis the hostname portion of the private IP's fully qualified domain name (FQDN)\n(for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`).\nMust be unique across all VNICs in the subnet and comply with\n[RFC 952](https://tools.ietf.org/html/rfc952) and\n[RFC 1123](https://tools.ietf.org/html/rfc1123).\n\nFor more information, see \n[DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm).\n\nExample: `bminstance1`\n" maxLength: 63 minLength: 1 type: string ipAddress: description: 'A private IP address of your choice. Must be an available IP address within the subnet''s CIDR. If you don''t specify a value, Oracle automatically assigns a private IP address from the subnet. Example: `10.0.3.3` ' maxLength: 32 minLength: 1 type: string ipv4SubnetCidrAtCreation: description: 'Any one of the IPv4 CIDRs allocated to the subnet. ' maxLength: 32 minLength: 1 type: string lifetime: default: EPHEMERAL description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string BulkDeletePrivateIpItem: description: Secondary private IPv4 address object to delete as part of a bulk operation. properties: privateIpId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secondary Private IP. ' maxLength: 255 minLength: 1 type: string required: - privateIpId AddedNetworkSecurityGroupSecurityRules: properties: securityRules: description: The NSG security rules that were added. items: $ref: '#/components/schemas/SecurityRule' type: array UpdateCaptureFilterDetails: description: 'These details can be included in a request to update a capture filter. A capture filter contains a set of rules governing what traffic a VTAP mirrors or a VCN flow log collects. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object vtapCaptureFilterRules: description: 'The set of rules governing what traffic a VTAP mirrors. ' items: $ref: '#/components/schemas/VtapCaptureFilterRuleDetails' type: array UpdateSecurityListDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string egressSecurityRules: description: Rules for allowing egress IP packets. items: $ref: '#/components/schemas/EgressSecurityRule' type: array freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object ingressSecurityRules: description: Rules for allowing ingress IP packets. items: $ref: '#/components/schemas/IngressSecurityRule' type: array SetOriginAsnDetails: description: Update Origin ASN of a BYOIP Range properties: asPathPrependLength: default: 1 description: The as path prepend length. minimum: 1 type: integer byoasnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` Resource to be associated. maxLength: 255 minLength: 1 type: string required: - byoasnId ServiceIdRequestDetails: additionalProperties: false properties: serviceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the [Service](#/en/iaas/latest/Service/). ' maxLength: 255 minLength: 1 type: string required: - serviceId CreateByoasnDetails: description: The information used to create a `Byoasn` resource. properties: asn: description: 'The Autonomous System Number (ASN) you are importing to the Oracle cloud. ' format: int64 maximum: 4294967294 minimum: 1 type: integer compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the BYOASN Resource. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId - asn - displayName GetPublicIpByPrivateIpIdDetails: description: 'Details of the private IP that the public IP is assigned to. ' properties: privateIpId: description: '[OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP. ' maxLength: 255 minLength: 1 type: string required: - privateIpId ChangeSecurityListCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the security list to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId AddDrgRouteDistributionStatementDetails: description: 'Details used to add a route distribution statement. ' properties: action: description: 'Accept: import/export the route "as is" ' enum: - ACCEPT type: string matchCriteria: description: 'The action is applied only if all of the match criteria is met. ' items: $ref: '#/components/schemas/DrgRouteDistributionMatchCriteria' maxItems: 1 minItems: 0 type: array priority: description: 'This field is used to specify the priority of each statement in a route distribution. The priority will be represented as a number between 0 and 65535 where a lower number indicates a higher priority. When a route is processed, statements are applied in the order defined by their priority. The first matching rule dictates the action that will be taken on the route. ' maximum: 65535 minimum: 1 type: integer required: - matchCriteria - action - priority Vnic: description: 'A virtual network interface card. Each VNIC resides in a subnet in a VCN. An instance attaches to a VNIC to obtain a network connection into the VCN through that subnet. Each instance has a *primary VNIC* that is automatically created and attached during launch. You can add *secondary VNICs* to an instance after it''s launched. For more information, see [Virtual Network Interface Cards (VNICs)](/iaas/Content/Network/Tasks/managingVNICs.htm). Each VNIC has a *primary private IP* that is automatically assigned during launch. You can add *secondary private IPs* to a VNIC after it''s created. For more information, see [CreatePrivateIp](#/en/iaas/latest/PrivateIp/CreatePrivateIp) and [IP Addresses](/iaas/Content/Network/Tasks/managingIPaddresses.htm). If you are an Oracle Cloud VMware Solution customer, you will have secondary VNICs that reside in a VLAN instead of a subnet. These VNICs have other differences, which are called out in the descriptions of the relevant attributes in the `Vnic` object. Also see [Vlan](#/en/iaas/latest/Vlan). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: availabilityDomain: description: 'The VNIC''s availability domain. Example: `Uocm:PHX-AD-1` ' maxLength: 255 minLength: 1 type: string compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the VNIC. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostnameLabel: description: 'The hostname for the VNIC''s primary private IP. Used for DNS. The value is the hostname portion of the primary private IP''s fully qualified domain name (FQDN) (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `bminstance1` ' maxLength: 63 minLength: 1 type: string id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. maxLength: 255 minLength: 1 type: string ipv6Addresses: description: 'List of IPv6 addresses assigned to the VNIC. Example: `2001:DB8::` ' items: maxLength: 45 minLength: 1 type: string type: array isPrimary: description: 'Whether the VNIC is the primary VNIC (the VNIC that is automatically created and attached during instance launch). ' type: boolean lifecycleState: description: The current state of the VNIC. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string macAddress: description: 'The MAC address of the VNIC. If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution, the MAC address is learned. If the VNIC belongs to a subnet, the MAC address is a static, Oracle-provided value. Example: `00:00:00:00:00:01` ' maxLength: 32 minLength: 1 type: string nsgIds: description: 'A list of the OCIDs of the network security groups that the VNIC belongs to. If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of belonging to a subnet), the value of the `nsgIds` attribute is ignored. Instead, the VNIC belongs to the NSGs that are associated with the VLAN itself. See [Vlan](#/en/iaas/latest/Vlan). For more information about NSGs, see [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/). ' items: maxLength: 255 minLength: 1 type: string maxItems: 5 type: array uniqueItems: true privateIp: description: 'The private IP address of the primary `privateIp` object on the VNIC. The address is within the CIDR of the VNIC''s subnet. Example: `10.0.3.3` ' type: string publicIp: description: 'The public IP address of the VNIC, if one is assigned. ' type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object skipSourceDestCheck: description: 'Whether the source/destination check is disabled on the VNIC. Defaults to `false`, which means the check is performed. For information about why you would skip the source/destination check, see [Using a Private IP as a Route Target](/iaas/Content/Network/Tasks/managingroutetables.htm#privateip). If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of belonging to a subnet), the `skipSourceDestCheck` attribute is `true`. This is because the source/destination check is always disabled for VNICs in a VLAN. Example: `true` ' type: boolean subnetId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet the VNIC is in. maxLength: 255 minLength: 1 type: string timeCreated: description: 'The date and time the VNIC was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vlanId: description: 'If the VNIC belongs to a VLAN as part of the Oracle Cloud VMware Solution (instead of belonging to a subnet), the `vlanId` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN the VNIC is in. See [Vlan](#/en/iaas/latest/Vlan). If the VNIC is instead in a subnet, `subnetId` has a value. ' maxLength: 255 minLength: 1 type: string required: - availabilityDomain - compartmentId - id - lifecycleState - timeCreated NetworkSecurityGroupVnic: description: 'Information about a VNIC that belongs to a network security group. ' properties: resourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the parent resource that the VNIC is attached to (for example, a Compute instance). ' maxLength: 255 minLength: 1 type: string timeAssociated: description: 'The date and time the VNIC was added to the network security group, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vnicId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. maxLength: 255 minLength: 1 type: string required: - vnicId ChangeVirtualCircuitCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to move the virtual circuit to. ' maxLength: 255 minLength: 1 type: string required: - compartmentId DhcpOptions: description: 'A set of DHCP options. Used by the VCN to automatically provide configuration information to the instances when they boot up. There are two options you can set: - [DhcpDnsOption](#/en/iaas/latest/DhcpDnsOption/): Lets you specify how DNS (hostname resolution) is handled in the subnets in your VCN. - [DhcpSearchDomainOption](#/en/iaas/latest/DhcpSearchDomainOption/): Lets you specify a search domain name to use for DNS queries. For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm) and [DHCP Options](/iaas/Content/Network/Tasks/managingDHCP.htm). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the set of DHCP options. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)) for the set of DHCP options. maxLength: 255 minLength: 1 type: string lifecycleState: description: The current state of the set of DHCP options. enum: - PROVISIONING - AVAILABLE - TERMINATING - TERMINATED type: string options: description: The collection of individual DHCP options. items: $ref: '#/components/schemas/DhcpOption' type: array timeCreated: description: 'Date and time the set of DHCP options was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the set of DHCP options belongs to. maxLength: 255 minLength: 1 type: string required: - id - compartmentId - options - lifecycleState - timeCreated - vcnId x-example: "{\n \"compartmentId\" : \"ocid1.compartment.oc1..<unique_ID>\",\n \"displayName\" : \"MyDhcpOptions\",\n \"id\" : \"ocid1.dhcpoptions.oc1.phx.<unique_ID>\",\n \"lifecycleState\" : \"AVAILABLE\",\n \"options\" : [{\n \"type\" : \"DomainNameServer\",\n \"customDnsServers\" : [\"203.0.113.7\"],\n \"serverType\":\"CustomDnsServer\"\n }],\n \"timeCreated\" : \"2016-12-17T01:31:50.047Z\",\n \"vcnId\" : \"ocid1.vcn.oc1.phx.<unique_ID>\"\n}\n" TunnelSecurityAssociationSummary: description: 'A summary of the IPSec tunnel security association details. ' properties: cpeSubnet: description: The IP address and mask of the partner subnet used in policy based VPNs or static routes. maxLength: 255 minLength: 1 type: string oracleSubnet: description: The IP address and mask of the local subnet used in policy based VPNs or static routes. maxLength: 255 minLength: 1 type: string time: description: Time in the current state, in seconds. maxLength: 255 minLength: 1 type: string tunnelSaErrorInfo: description: 'Current state if the IPSec tunnel status is not `UP`, including phase one and phase two details and a possible reason the tunnel is not `UP`. ' maxLength: 255 minLength: 1 type: string tunnelSaStatus: description: The IPSec tunnel's phase one status. enum: - INITIATING - LISTENING - UP - DOWN - ERROR - UNKNOWN type: string CrossConnectGroup: description: 'For use with Oracle Cloud Infrastructure FastConnect. A cross-connect group is a link aggregation group (LAG), which can contain one or more [CrossConnects](#/en/iaas/latest/CrossConnect). Customers who are colocated with Oracle in a FastConnect location create and use cross-connect groups. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). **Note:** If you''re a provider who is setting up a physical connection to Oracle so customers can use FastConnect over the connection, be aware that your connection is modeled the same way as a colocated customer''s (with `CrossConnect` and `CrossConnectGroup` objects, and so on). To use any of the API operations, you must be authorized in an IAM policy. If you''re not authorized, talk to an administrator. If you''re an administrator who needs to write policies to give users access, see [Getting Started with Policies](/iaas/Content/Identity/Concepts/policygetstarted.htm). ' properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the cross-connect group. maxLength: 255 minLength: 1 type: string customerReferenceName: description: 'A reference name or identifier for the physical fiber connection that this cross-connect group uses. ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The cross-connect group's Oracle ID (OCID). maxLength: 255 minLength: 1 type: string lifecycleState: description: The cross-connect group's current state. enum: - PROVISIONING - PROVISIONED - INACTIVE - TERMINATING - TERMINATED type: string macsecProperties: $ref: '#/components/schemas/MacsecProperties' ociLogicalDeviceName: description: 'The FastConnect device that terminates the logical connection. This device might be different than the device that terminates the physical connection. ' maxLength: 255 minLength: 1 type: string ociPhysicalDeviceName: description: 'The FastConnect device that terminates the physical connection. ' maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }` ' type: object timeCreated: description: 'The date and time the cross-connect group was created, in the format defined by [RFC3339](https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string DhcpOption: description: 'A single DHCP option according to [RFC 1533](https://tools.ietf.org/html/rfc1533). The two options available to use are [DhcpDnsOption](#/en/iaas/latest/DhcpDnsOption/) and [DhcpSearchDomainOption](#/en/iaas/latest/DhcpSearchDomainOption/). For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm) and [DHCP Options](/iaas/Content/Network/Tasks/managingDHCP.htm). ' discriminator: propertyName: type properties: type: description: 'The specific DHCP option. Either `DomainNameServer` (for [DhcpDnsOption](#/en/iaas/latest/DhcpDnsOption/)) or `SearchDomain` (for [DhcpSearchDomainOption](#/en/iaas/latest/DhcpSearchDomainOption/)). ' type: string required: - type type: object DpdConfig: description: 'These configuration details are used for dead peer detection (DPD). DPD periodically checks the stability of the connection to the customer premises (CPE), and may be used to detect that the link to the CPE has gone down. ' properties: dpdMode: description: 'This option defines whether DPD can be initiated from the Oracle side of the connection. ' enum: - INITIATE_AND_RESPOND - RESPOND_ONLY type: string dpdTimeoutInSec: description: 'DPD timeout in seconds. This sets the longest interval between CPE device health messages before the IPSec connection indicates it has lost contact with the CPE. The default is 20 seconds. ' type: integer type: object PhaseTwoConfigDetails: description: Configuration details for IPSec phase two configuration parameters. properties: authenticationAlgorithm: description: 'The authentication algorithm proposed during phase two tunnel negotiation. ' enum: - HMAC_SHA2_256_128 - HMAC_SHA1_128 type: string encryptionAlgorithm: description: 'The encryption algorithm proposed during phase two tunnel negotiation. ' enum: - AES_256_GCM - AES_192_GCM - AES_128_GCM - AES_256_CBC - AES_192_CBC - AES_128_CBC type: string isCustomPhaseTwoConfig: description: Indicates whether custom configuration is enabled for phase two options. type: boolean isPfsEnabled: description: Indicates whether perfect forward secrecy (PFS) is enabled. type: boolean lifetimeInSeconds: description: 'Lifetime in seconds for the IPSec session key set in phase two. The default is 3600 which is equivalent to 1 hour. ' type: integer pfsDhGroup: description: The Diffie-Hellman group used for PFS, if PFS is enabled. enum: - GROUP2 - GROUP5 - GROUP14 - GROUP19 - GROUP20 - GROUP24 type: string type: object UpdateIPSecConnectionTunnelSharedSecretDetails: properties: sharedSecret: description: 'The shared secret (pre-shared key) to use for the tunnel. Only numbers, letters, and spaces are allowed. ' maxLength: 255 minLength: 1 type: string BulkDeleteVirtualCircuitPublicPrefixesDetails: properties: publicPrefixes: description: 'The public IP prefixes (CIDRs) to remove from the public virtual circuit. ' items: $ref: '#/components/schemas/DeleteVirtualCircuitPublicPrefixDetails' maximum: 50 minimum: 0 type: array required: - publicPrefixes BulkDeleteIpv6sItem: description: A secondary IPv6 object to delete as part of a bulk deletion. properties: ipv6Id: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6 to delete. maxLength: 255 minLength: 1 type: string required: - ipv6Id AddSecurityRuleDetails: description: A rule for allowing inbound (INGRESS) or outbound (EGRESS) IP packets. properties: description: description: 'An optional description of your choice for the rule. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string destination: description: "Conceptually, this is the range of IP addresses that a packet originating from the instance\ncan go to.\n\nAllowed values:\n\n * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`\n IPv6 addressing is supported for all commercial and government regions. See\n [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm).\n\n * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're\n setting up a security rule for traffic destined for a particular `Service` through\n a service gateway. For example: `oci-phx-objectstorage`.\n\n * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same\n VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control\n traffic between VNICs in the same NSG.\n" type: string destinationType: description: "Type of destination for the rule. Required if `direction` = `EGRESS`.\n\nAllowed values:\n\n * `CIDR_BLOCK`: If the rule's `destination` is an IP address range in CIDR notation.\n\n * `SERVICE_CIDR_BLOCK`: If the rule's `destination` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic destined for a\n particular `Service` through a service gateway).\n\n * `NETWORK_SECURITY_GROUP`: If the rule's `destination` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a\n [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK - NETWORK_SECURITY_GROUP type: string direction: description: 'Direction of the security rule. Set to `EGRESS` for rules to allow outbound IP packets, or `INGRESS` for rules to allow inbound IP packets. ' enum: - EGRESS - INGRESS type: string icmpOptions: $ref: '#/components/schemas/IcmpOptions' isStateless: description: 'A stateless rule allows traffic in one direction. Remember to add a corresponding stateless rule in the other direction if you need to support bidirectional traffic. For example, if egress traffic allows TCP destination port 80, there should be an ingress rule to allow TCP source port 80. Defaults to false, which means the rule is stateful and a corresponding rule is not necessary for bidirectional traffic. ' type: boolean protocol: description: 'The transport protocol. Specify either `all` or an IPv4 protocol number as defined in [Protocol Numbers](http://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml). Options are supported only for ICMP ("1"), TCP ("6"), UDP ("17"), and ICMPv6 ("58"). ' type: string source: description: "Conceptually, this is the range of IP addresses that a packet coming into the instance\ncan come from.\n\nAllowed values:\n\n * An IP address range in CIDR notation. For example: `192.168.1.0/24` or `2001:0db8:0123:45::/56`\n IPv6 addressing is supported for all commercial and government regions. See\n [IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm).\n\n * The `cidrBlock` value for a [Service](#/en/iaas/latest/Service/), if you're\n setting up a security rule for traffic coming from a particular `Service` through\n a service gateway. For example: `oci-phx-objectstorage`.\n\n * The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/) in the same\n VCN. The value can be the NSG that the rule belongs to if the rule's intent is to control\n traffic between VNICs in the same NSG.\n" type: string sourceType: description: "Type of source for the rule. Required if `direction` = `INGRESS`.\n\n * `CIDR_BLOCK`: If the rule's `source` is an IP address range in CIDR notation.\n\n * `SERVICE_CIDR_BLOCK`: If the rule's `source` is the `cidrBlock` value for a\n [Service](#/en/iaas/latest/Service/) (the rule is for traffic coming from a\n particular `Service` through a service gateway).\n\n * `NETWORK_SECURITY_GROUP`: If the rule's `source` is the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of a\n [NetworkSecurityGroup](#/en/iaas/latest/NetworkSecurityGroup/).\n" enum: - CIDR_BLOCK - SERVICE_CIDR_BLOCK - NETWORK_SECURITY_GROUP type: string tcpOptions: $ref: '#/components/schemas/TcpOptions' udpOptions: $ref: '#/components/schemas/UdpOptions' required: - direction - protocol UpdateVtapDetails: description: These details can be included in a request to update a virtual test access point (VTAP). properties: captureFilterId: description: 'The capture filter''s Oracle ID ([OCID](/iaas/Content/General/Concepts/identifiers.htm)). ' maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string encapsulationProtocol: description: 'Defines an encapsulation header type for the VTAP''s mirrored traffic. ' enum: - VXLAN type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isVtapEnabled: default: false description: 'Used to start or stop a `Vtap` resource. * `TRUE` directs the VTAP to start mirroring traffic. * `FALSE` (Default) directs the VTAP to stop mirroring traffic. ' type: boolean maxPacketSize: description: The maximum size of the packets to be included in the filter. format: int32 type: integer sourceId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the source point where packets are captured. ' maxLength: 255 minLength: 1 type: string sourcePrivateEndpointIp: description: 'The IP Address of the source private endpoint. ' maxLength: 46 minLength: 1 type: string sourcePrivateEndpointSubnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet that source private endpoint belongs to. ' maxLength: 255 minLength: 1 type: string sourceType: description: 'The source type for the VTAP. ' enum: - VNIC - SUBNET - LOAD_BALANCER - DB_SYSTEM - EXADATA_VM_CLUSTER - AUTONOMOUS_DATA_WAREHOUSE type: string targetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the destination resource where mirrored packets are sent. ' maxLength: 255 minLength: 1 type: string targetIp: description: 'The IP address of the destination resource where mirrored packets are sent. ' maxLength: 46 minLength: 1 type: string targetType: description: 'The target type for the VTAP. ' enum: - VNIC - NETWORK_LOAD_BALANCER - IP_ADDRESS type: string trafficMode: default: DEFAULT description: Used to control the priority of traffic. It is an optional field. If it not passed, the value is DEFAULT enum: - DEFAULT - PRIORITY type: string vxlanNetworkIdentifier: description: 'The virtual extensible LAN (VXLAN) network identifier (or VXLAN segment ID) that uniquely identifies the VXLAN. ' format: int64 type: integer CreatePrivateIpDetails: properties: cidrPrefixLength: default: 32 description: "An optional field that when combined with the ipAddress field, will be used to allocate secondary IPv4 CIDRs.\nThe CIDR range created by this combination must be within the subnet's CIDR \nand the CIDR range should not collide with any existing IPv4 address allocation.\nThe VNIC ID specified in the request object should not already been assigned more than the max IPv4 addresses.\nIf you don't specify a value, this option will be ignored.\n\nExample: 18\n" maximum: 32 minimum: 18 type: integer definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostnameLabel: description: 'The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP''s fully qualified domain name (FQDN) (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `bminstance1` ' maxLength: 63 minLength: 1 type: string ipAddress: description: 'A private IP address of your choice. Must be an available IP address within the subnet''s CIDR. If you don''t specify a value, Oracle automatically assigns a private IP address from the subnet. Example: `10.0.3.3` ' maxLength: 32 minLength: 1 type: string ipv4SubnetCidrAtCreation: description: 'Any one of the IPv4 CIDRs allocated to the subnet. ' maxLength: 32 minLength: 1 type: string lifetime: default: EPHEMERAL description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string subnetId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet from which the private IP is to be drawn. The IP address, *if supplied*, must be valid for the given subnet. ' maxLength: 255 minLength: 1 type: string vlanId: description: 'Use this attribute only with the Oracle Cloud VMware Solution. The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN from which the private IP is to be drawn. The IP address, *if supplied*, must be valid for the given VLAN. See [Vlan](#/en/iaas/latest/Vlan). ' maxLength: 255 minLength: 1 type: string vnicId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC to assign the private IP to. The VNIC and private IP must be in the same subnet. ' maxLength: 255 minLength: 1 type: string BulkUpdatePrivateIpItem: description: A secondary private IPv4 address object to update as part of a bulk operation. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object hostnameLabel: description: 'The hostname for the private IP. Used for DNS. The value is the hostname portion of the private IP''s fully qualified domain name (FQDN) (for example, `bminstance1` in FQDN `bminstance1.subnet123.vcn1.oraclevcn.com`). Must be unique across all VNICs in the subnet and comply with [RFC 952](https://tools.ietf.org/html/rfc952) and [RFC 1123](https://tools.ietf.org/html/rfc1123). For more information, see [DNS in Your Virtual Cloud Network](/iaas/Content/Network/Concepts/dns.htm). Example: `bminstance1` ' maxLength: 63 minLength: 1 type: string lifetime: default: EPHEMERAL description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string privateIpId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the secondary Private IP. ' maxLength: 255 minLength: 1 type: string routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string required: - privateIpId IcmpOptions: description: 'Optional and valid only for ICMP and ICMPv6. Use to specify a particular ICMP type and code as defined in: - [ICMP Parameters](http://www.iana.org/assignments/icmp-parameters/icmp-parameters.xhtml) - [ICMPv6 Parameters](https://www.iana.org/assignments/icmpv6-parameters/icmpv6-parameters.xhtml) If you specify ICMP or ICMPv6 as the protocol but omit this object, then all ICMP types and codes are allowed. If you do provide this object, the type is required and the code is optional. To enable MTU negotiation for ingress internet traffic via IPv4, make sure to allow type 3 ("Destination Unreachable") code 4 ("Fragmentation Needed and Don''t Fragment was Set"). If you need to specify multiple codes for a single type, create a separate security list rule for each. ' properties: code: description: The ICMP code (optional). maximum: 16 minimum: 0 type: integer type: description: The ICMP type. maximum: 254 minimum: 0 type: integer required: - type RemoveDrgRouteDistributionStatementsDetails: description: 'Details request to remove statements from a route distribution. ' properties: statementIds: description: 'The Oracle-assigned ID of each route distribution to remove. ' items: type: string maxItems: 100 minItems: 1 type: array AllowedPhaseOneParameters: description: Allowed phase one parameters. properties: authenticationAlgorithms: description: Allowed phase one authentication algorithms. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array dhGroups: description: Allowed phase one Diffie-Hellman groups. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array encryptionAlgorithms: description: Allowed phase one encryption algorithms. items: maxLength: 50 minLength: 1 type: string maxItems: 20 type: array UpdateLocalPeeringGatewayDetails: properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the LPG will use. For information about why you would associate a route table with an LPG, see [Transit Routing: Access to Multiple VCNs in Same Region](/iaas/Content/Network/Tasks/transitrouting.htm). ' maxLength: 255 minLength: 1 type: string securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object VirtualCircuitPublicPrefix: description: 'A public IP prefix and its details. With a public virtual circuit, the customer specifies the customer-owned public IP prefixes to advertise across the connection. For more information, see [FastConnect Overview](/iaas/Content/Network/Concepts/fastconnect.htm). ' properties: cidrBlock: description: Publix IP prefix (CIDR) that the customer specified. maxLength: 50 minLength: 4 type: string verificationState: description: 'Oracle must verify that the customer owns the public IP prefix before traffic for that prefix can flow across the virtual circuit. Verification can take a few business days. `IN_PROGRESS` means Oracle is verifying the prefix. `COMPLETED` means verification succeeded. `FAILED` means verification failed and traffic for this prefix will not flow across the connection. ' enum: - IN_PROGRESS - COMPLETED - FAILED type: string required: - cidrBlock - verificationState CreateRouteTableDetails: properties: compartmentId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment to contain the route table. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object routeRules: description: 'The collection of rules used for routing destination IPs to network devices. ' items: $ref: '#/components/schemas/RouteRule' type: array vcnId: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN the route table belongs to. maxLength: 255 minLength: 1 type: string required: - compartmentId - routeRules - vcnId AddSubnetIpv6CidrDetails: description: Details used when adding an IPv6 prefix to a subnet. properties: ipv6CidrBlock: description: 'This field is not required and should only be specified when adding an IPv6 prefix to a subnet''s IPv6 address space. See[IPv6 Addresses](/iaas/Content/Network/Concepts/ipv6.htm). Example: `2001:0db8:0123::/64` ' maxLength: 45 minLength: 1 type: string required: - ipv6CidrBlock parameters: AvailabilityDomainQueryParam: description: 'The name of the availability domain. Example: `Uocm:PHX-AD-1` ' in: query name: availabilityDomain required: false schema: type: string VtapSourceIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP source. in: query name: source required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match schema: type: string NetworkIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG. in: query name: networkId required: false schema: type: string maxLength: 255 minLength: 1 SubnetIdPathParam: description: Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet. in: path name: subnetId required: true schema: type: string maxLength: 255 minLength: 1 SubnetIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet. in: query name: subnetId required: false schema: type: string maxLength: 255 minLength: 1 CpeIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE. in: query name: cpeId required: false schema: type: string maxLength: 255 minLength: 1 VtapTargetIpOptionalQueryParam: description: The IP address of the VTAP target. in: query name: targetIp required: false x-default-description: 'null' schema: type: string maxLength: 46 minLength: 1 RouteTableIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table. in: path name: rtId required: true schema: type: string maxLength: 255 minLength: 1 VirtualCircuitIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the virtual circuit. in: path name: virtualCircuitId required: true schema: type: string maxLength: 255 minLength: 1 CpeDeviceShapeIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE device shape. in: path name: cpeDeviceShapeId required: true schema: type: string maxLength: 255 minLength: 1 IpAddressOptionalQueryParam: description: 'An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: `10.0.3.3` ' in: query name: ipAddress required: false schema: type: string DrgIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. in: query name: drgId required: true schema: type: string maxLength: 255 minLength: 1 ByoasnSortByQueryParam: description: 'The field to sort by, for byoasn List operation. ' in: query name: sortBy required: false schema: type: string enum: - TIMECREATED - DISPLAYNAME default: TIMECREATED FilterByPublicIpPoolIdQueryParam: description: 'A filter to return only resources that belong to the given public IP pool. ' in: query name: publicIpPoolId required: false schema: type: string maxLength: 255 minLength: 1 CpeIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the CPE. in: path name: cpeId required: true schema: type: string maxLength: 255 minLength: 1 PaginationLimitQueryParam: description: 'For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). Example: `50` ' in: query name: limit x-default-description: The default maximum results per page varies by API. schema: type: integer maximum: 100 minimum: 1 ProviderServiceIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the provider service. in: path name: providerServiceId required: true schema: type: string maxLength: 255 minLength: 1 RouteTypeQueryParam: description: 'Static routes are specified through the DRG route table API. Dynamic routes are learned by the DRG from the DRG attachments through various routing protocols. ' in: query name: routeType required: false schema: type: string enum: - STATIC - DYNAMIC SecurityRuleDirectionOptionalQueryParam: description: 'Direction of the security rule. Set to `EGRESS` for rules that allow outbound IP packets, or `INGRESS` for rules that allow inbound IP packets. ' in: query name: direction required: false schema: type: string enum: - EGRESS - INGRESS IfNoneMatchHeader: description: "For querying if there is a cached value on the server. The If-None-Match HTTP request header \nmakes the request conditional. For GET and HEAD methods, the server will send back the requested \nresource, with a 200 status, only if it doesn't have an ETag matching the given ones. \nFor other methods, the request will be processed only if the eventually existing resource's \nETag doesn't match any of the values listed.\n" in: header name: if-none-match x-default-description: '' schema: type: string VcnIdPathParam: description: Specify the [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. in: path name: vcnId required: true schema: type: string maxLength: 255 minLength: 1 SortOrderQueryParam: description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. ' in: query name: sortOrder required: false x-default-description: The default sort order varies by API. schema: type: string enum: - ASC - DESC default: ASC CrossConnectIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect. in: path name: crossConnectId required: true schema: type: string maxLength: 255 minLength: 1 IPSecConnectionIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection. in: path name: ipscId required: true schema: type: string maxLength: 255 minLength: 1 ByoasnIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `Byoasn` resource. in: path name: byoasnId required: true schema: type: string maxLength: 255 minLength: 1 CaptureFilterIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the capture filter. in: path name: captureFilterId required: true schema: type: string maxLength: 255 minLength: 1 VtapTargetIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP target. in: query name: targetId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 DhcpIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) for the set of DHCP options. in: path name: dhcpId required: true schema: type: string maxLength: 255 minLength: 1 ServiceIdPathParam: description: The service's [OCID](/iaas/Content/General/Concepts/identifiers.htm). in: path name: serviceId required: true schema: type: string maxLength: 255 minLength: 1 FilterByLifecycleStateQueryParam: description: 'A filter to return only resources that match the given lifecycle state name exactly. ' in: query name: lifecycleState required: false schema: type: string maxLength: 255 minLength: 1 ListNetworkSecurityGroupVnicsSortByQueryParam: description: The field to sort by. in: query name: sortBy required: false schema: type: string enum: - TIMEASSOCIATED FilterByByoipRangeIdQueryParam: description: 'A filter to return only resources that match the given BYOIP CIDR block. ' in: query name: byoipRangeId required: false schema: type: string maxLength: 255 minLength: 1 NatGatewayIdPathParam: description: The NAT gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm). in: path name: natGatewayId required: true schema: type: string maxLength: 255 minLength: 1 InternetGatewayIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the internet gateway. in: path name: igId required: true schema: type: string maxLength: 255 minLength: 1 RemotePeeringConnectionIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the remote peering connection (RPC). in: path name: remotePeeringConnectionId required: true schema: type: string maxLength: 255 minLength: 1 FilterByVtapLifecycleStateQueryParam: description: 'A filter to return only resources that match the given VTAP administrative lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/Vtap/lifecycleState' schema: type: string DrgRouteDistributionIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route distribution. in: path name: drgRouteDistributionId required: true schema: type: string maxLength: 255 minLength: 1 CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. in: query name: compartmentId required: true schema: type: string maxLength: 255 minLength: 1 ListNetworkSecurityGroupSecurityRulesSortByQueryParam: description: The field to sort by. in: query name: sortBy required: false schema: type: string enum: - TIMECREATED DrgAttachmentTypeQueryParam: description: The type for the network resource attached to the DRG. in: query name: attachmentType required: false schema: type: string enum: - VCN - VIRTUAL_CIRCUIT - REMOTE_PEERING_CONNECTION - IPSEC_TUNNEL - ALL default: VCN ListDrgRouteDistributionStatementsSortByQueryParam: description: The field to sort by. in: query name: sortBy required: false schema: type: string enum: - TIMECREATED CompartmentIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment. in: query name: compartmentId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 LocalPeeringGatewayIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the local peering gateway. in: path name: localPeeringGatewayId required: true schema: type: string maxLength: 255 minLength: 1 PublicIpPoolIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP pool. in: path name: publicIpPoolId required: true schema: type: string maxLength: 255 minLength: 1 BgpRouteAdvertiserQueryParam: description: 'Specifies the advertiser of the routes. If set to `ORACLE`, this returns only the routes advertised by Oracle. When set to `CUSTOMER`, this returns only the routes advertised by the CPE. ' in: query name: advertiser required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/TunnelRouteSummary/advertiser' schema: type: string IpStateOptionalQueryParam: description: State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED otherwise AVAILABLE in: query name: ipState required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 FilterByDisplayNameQueryParam: description: 'A filter to return only resources that match the given display name exactly. ' in: query name: displayName required: false schema: type: string maxLength: 255 minLength: 1 CrossConnectGroupIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group. in: query name: crossConnectGroupId required: false schema: type: string maxLength: 255 minLength: 1 LifetimeOptionalQueryParam: description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" in: query name: lifetime required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 FilterByCaptureFilterLifecycleStateQueryParam: description: 'A filter to return only resources that match the given capture filter lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/CaptureFilter/lifecycleState' schema: type: string IPSecConnectionTunnelIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel. in: path name: tunnelId required: true schema: type: string maxLength: 255 minLength: 1 DrgRouteTableIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table assigned to the DRG attachment. in: query name: drgRouteTableId required: false schema: type: string maxLength: 255 minLength: 1 VlanIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. in: path name: vlanId required: true schema: type: string maxLength: 255 minLength: 1 DataRequestIdPathParam: description: Specify the ID of the resource. in: path name: dataRequestId required: true schema: type: string maxLength: 255 minLength: 1 PublicIpLifetimeQueryParam: description: 'A filter to return only public IPs that match given lifetime. ' in: query name: lifetime required: false schema: type: string enum: - EPHEMERAL - RESERVED VcnIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. in: query name: vcnId required: false schema: type: string maxLength: 255 minLength: 1 ServiceGatewayIdPathParam: description: The service gateway's [OCID](/iaas/Content/General/Concepts/identifiers.htm). in: path name: serviceGatewayId required: true schema: type: string maxLength: 255 minLength: 1 SubnetIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the subnet. in: query name: subnetId required: true schema: type: string maxLength: 255 minLength: 1 CrossConnectGroupIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the cross-connect group. in: path name: crossConnectGroupId required: true schema: type: string maxLength: 255 minLength: 1 NetworkSecurityGroupIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the network security group. in: path name: networkSecurityGroupId required: true schema: type: string maxLength: 255 minLength: 1 ByoipRangeIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the `ByoipRange` resource containing the BYOIP CIDR block. in: path name: byoipRangeId required: true schema: type: string maxLength: 255 minLength: 1 VnicIdOptionalQueryParam: description: The OCID of the VNIC. in: query name: vnicId required: false schema: type: string SecurityListIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the security list. in: path name: securityListId required: true schema: type: string maxLength: 255 minLength: 1 CacheControlHeader: description: 'The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses. ' in: header name: cache-control x-default-description: '' schema: type: string Ipv6IdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPv6. in: path name: ipv6Id required: true schema: type: string maxLength: 255 minLength: 1 VnicIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VNIC. in: path name: vnicId required: true schema: type: string maxLength: 255 minLength: 1 DrgRouteTableIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG route table. in: path name: drgRouteTableId required: true schema: type: string maxLength: 255 minLength: 1 ProviderServiceKeyNamePathParam: description: 'The provider service key that the provider gives you when you set up a virtual circuit connection from the provider to Oracle Cloud Infrastructure. You can set up that connection and get your provider service key at the provider''s website or portal. For the portal location, see the `description` attribute of the [FastConnectProviderService](#/en/iaas/latest/FastConnectProviderService/). ' in: path name: providerServiceKeyName required: true schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: 'Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' in: header name: opc-request-id schema: type: string pattern: '[A-Za-z0-9\-_\.]+' SortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. **Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted. ' in: query name: sortBy required: false x-default-description: The default field to sort by varies by API. schema: type: string enum: - TIMECREATED - DISPLAYNAME AccessLevelQueryParam: description: 'Valid values are `ANY` and `ACCESSIBLE`. The default is `ANY`. Setting this to `ACCESSIBLE` returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions. When set to `ANY` permissions are not checked. ' in: query name: accessLevel x-default-description: ANY schema: type: string enum: - ANY - ACCESSIBLE PublicIpScopeQueryParam: description: 'Whether the public IP is regional or specific to a particular availability domain. * `REGION`: The public IP exists within a region and is assigned to a regional entity (such as a [NatGateway](#/en/iaas/latest/NatGateway/)), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs have `scope` = `REGION`, as do ephemeral public IPs assigned to a regional entity. * `AVAILABILITY_DOMAIN`: The public IP exists within the availability domain of the entity it''s assigned to, which is specified by the `availabilityDomain` property of the public IP object. Ephemeral public IPs that are assigned to private IPs have `scope` = `AVAILABILITY_DOMAIN`. ' in: query name: scope required: true schema: type: string enum: - REGION - AVAILABILITY_DOMAIN VcnIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VCN. in: query name: vcnId required: true schema: type: string maxLength: 255 minLength: 1 VtapIsEnabledOptionalQueryParam: description: 'Indicates whether to list all VTAPs or only running VTAPs. * When `FALSE`, lists ALL running and stopped VTAPs. * When `TRUE`, lists only running VTAPs (VTAPs where isVtapEnabled = `TRUE`). ' in: query name: isVtapEnabled required: false schema: type: boolean default: false CrossTenancyQueryParam: description: Whether the DRG attachment lives in a different tenancy than the DRG. in: query name: isCrossTenancy required: false schema: type: boolean default: false DrgAttachmentIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG attachment. in: path name: drgAttachmentId required: true schema: type: string maxLength: 255 minLength: 1 VtapIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VTAP. in: path name: vtapId required: true schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List" call. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' in: query name: page schema: type: string maxLength: 4096 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected). ' in: header name: opc-retry-token schema: type: string maxLength: 64 minLength: 1 QueryCompartmentSubtreeQueryParam: description: 'When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of `accessLevel`. Default is false. ' in: query name: queryCompartmentSubtree x-default-description: false schema: type: boolean VlanIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the VLAN. in: query name: vlanId required: false x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PrivateIpIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the private IP or IPv6. in: path name: privateIpId required: true schema: type: string maxLength: 255 minLength: 1 DrgIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. in: path name: drgId required: true schema: type: string maxLength: 255 minLength: 1 ImportDrgRouteDistributionIdQueryParam: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the import route distribution. ' in: query name: importDrgRouteDistributionId required: false schema: type: string maxLength: 255 minLength: 1 PublicIpIdPathParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the public IP. in: path name: publicIpId required: true schema: type: string maxLength: 255 minLength: 1 DrgIdOptionalQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG. in: query name: drgId required: false x-default-description: '' schema: type: string maxLength: 255 minLength: 1 responses: DefaultError: description: An error has occurred. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: data-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the resource. ' type: string displayName: description: 'A user-friendly name. Does not have to be unique, and it''s changeable. Avoid entering confidential information. ' maxLength: 255 minLength: 1 type: string etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string lifecycle-state: description: The IpInventory API current state. enum: - IN_PROGRESS - DONE type: string location: description: 'Location of the resource. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-total-items: description: 'For list pagination. A pagination token to get the total number of results available. ' type: integer opc-work-request-id: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request. Use [GetWorkRequest](/api/#/en/workrequests/latest/WorkRequest/GetWorkRequest) with this ID to track the status of the request. ' type: string x-platform-config-properties: amdNumaNodesPerSocketNps1: default: NPS1 description: 'The number of NUMA nodes per socket (NPS). ' enum: - NPS0 - NPS1 - NPS2 - NPS4 - NPS6 type: string amdNumaNodesPerSocketNps4: default: NPS4 description: 'The number of NUMA nodes per socket (NPS). ' enum: - NPS0 - NPS1 - NPS2 - NPS4 - NPS6 type: string areVirtualInstructionsEnabledFalse: default: false description: 'Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. ' type: boolean areVirtualInstructionsEnabledTrue: default: true description: 'Whether virtualization instructions are available. For example, Secure Virtual Machine for AMD shapes or VT-x for Intel shapes. ' type: boolean configMap: additionalProperties: type: string description: 'Instance Platform Configuration Configuration Map for flexible setting input. ' type: object definedTagsFilter: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Filter based on these defined tags. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). ' type: object imageVolumeIndex: description: 'When launching from a Compute Image, it is possible for more than one volume to be defined in the Image definition. If the relative index of one of these volumes is provided in this field, then the provided createVolumeDetails descriptor will be utilized to modify the default creation/attachment parameters for this volume rather than the defaults. If this field is provided, then CreateVolumeDetails must be specified. ' minimum: 1 type: integer x-default-description: 'null' intelNumaNodesPerSocketNps1: default: NPS1 description: 'The number of NUMA nodes per socket (NPS). ' enum: - NPS1 - NPS2 type: string isAccessControlServiceEnabledFalse: default: false description: 'Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through. ' type: boolean isAccessControlServiceEnabledTrue: default: true description: 'Whether the Access Control Service is enabled on the instance. When enabled, the platform can enforce PCIe device isolation, required for VFIO device pass-through. ' type: boolean isInputOutputMemoryManagementUnitEnabledFalse: default: false description: 'Whether the input-output memory management unit is enabled. ' type: boolean isInputOutputMemoryManagementUnitEnabledTrue: default: true description: 'Whether the input-output memory management unit is enabled. ' type: boolean isSymmetricMultiThreadingEnabledTrue: default: true description: 'Whether symmetric multithreading is enabled on the instance. Symmetric multithreading is also called simultaneous multithreading (SMT) or Intel Hyper-Threading. Intel and AMD processors have two hardware execution threads per core (OCPU). SMT permits multiple independent threads of execution, to better use the resources and increase the efficiency of the CPU. When multithreading is disabled, only one thread is permitted to run on each core, which can provide higher or more predictable performance for some workloads. ' type: boolean percentageOfCoresEnabled: default: 100 description: 'The percentage of cores enabled. Value must be a multiple of 25%. If the requested percentage results in a fractional number of cores, the system rounds up the number of cores across processors and provisions an instance with a whole number of cores. If the applications that you run on the instance use a core-based licensing model and need fewer cores than the full size of the shape, you can disable cores to reduce your licensing costs. The instance itself is billed for the full shape, regardless of whether all cores are enabled. ' maximum: 100 minimum: 25 multipleOf: 25 type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object recycleLevel: description: 'Preferred recycle level for hosts associated with the reservation config. * `SKIP_RECYCLE` - Skips host wipe. * `FULL_RECYCLE` - Does not skip host wipe. This is the default behavior. ' enum: - SKIP_RECYCLE - FULL_RECYCLE type: string securityAttributes: additionalProperties: additionalProperties: description: 'The value of the tag. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a [ZPR namespace](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attribute-namespaces). ' type: object description: '[Security attributes](/iaas/Content/zero-trust-packet-routing/zpr-artifacts.htm#security-attributes) are labels for a resource that can be referenced in a [Zero Trust Packet Routing](/iaas/Content/zero-trust-packet-routing/overview.htm) (ZPR) policy to control access to ZPR-supported resources. Example: `{"Oracle-DataSecurity-ZPR": {"MaxEgressCount": {"value":"42","mode":"audit"}}}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{ "orcl-cloud": { "free-tier-retained": "true" } }` ' type: object x-network-ip-lifetime-default-properties: lifetime: default: EPHEMERAL description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string x-network-ip-lifetime-properties: lifetime: description: "Lifetime of the IP address.\nThere are two types of IPs:\n - Ephemeral\n - Reserved\n" enum: - EPHEMERAL - RESERVED type: string x-network-ip-state-properties: ipState: description: 'State of the IP address. If an IP address is assigned to a VNIC it is ASSIGNED, otherwise it is AVAILABLE. ' enum: - ASSIGNED - AVAILABLE type: string x-obmcs-client-circuit-breaker-table: dummy: enabled: false x-obmcs-client-retries-table: blockStorage: enabled: true c3: enabled: true pnp: enabled: true x-route-table-id-properties: routeTableId: description: 'The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the route table the IP address or VNIC will use. For more information, see [Per-resource Routing](https://docs.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#Overview_of_Routing_for_Your_VCN__source_routing). ' maxLength: 255 minLength: 0 type: string