ip_sec_connection_tunnel_shared_secrets
Creates, updates, deletes, gets or lists an ip_sec_connection_tunnel_shared_secrets resource.
Overview​
| Name | ip_sec_connection_tunnel_shared_secrets |
| Type | Resource |
| Id | oci.network.ip_sec_connection_tunnel_shared_secrets |
Fields​
The following fields are returned by SELECT queries:
- get
The information was retrieved.
| Name | Datatype | Description |
|---|---|---|
sharedSecret | string | The tunnel's shared secret (pre-shared key). |
Methods​
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | ipscId, tunnelId, region | Gets the specified tunnel's shared secret (pre-shared key). To get other information<br />about the tunnel, use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).<br /> | |
update | update | ipscId, tunnelId, region | if-match | Updates the shared secret (pre-shared key) for the specified tunnel.<br /><br />Important: If you change the shared secret, the tunnel will go down while it's reprovisioned.<br /> |
Parameters​
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
ipscId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the IPSec connection. |
region | string | OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION) |
tunnelId | string | The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the tunnel. |
if-match | string | 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. |
SELECT examples​
- get
Gets the specified tunnel's shared secret (pre-shared key). To get other information<br />about the tunnel, use [GetIPSecConnectionTunnel](#/en/iaas/latest/IPSecConnectionTunnel/GetIPSecConnectionTunnel).<br />
SELECT
sharedSecret
FROM oci.network.ip_sec_connection_tunnel_shared_secrets
WHERE ipscId = '{{ ipscId }}' -- required
AND tunnelId = '{{ tunnelId }}' -- required
AND region = '{{ region }}' -- required
;
UPDATE examples​
- update
Updates the shared secret (pre-shared key) for the specified tunnel.<br /><br />Important: If you change the shared secret, the tunnel will go down while it's reprovisioned.<br />
UPDATE oci.network.ip_sec_connection_tunnel_shared_secrets
SET
sharedSecret = '{{ sharedSecret }}'
WHERE
ipscId = '{{ ipscId }}' --required
AND tunnelId = '{{ tunnelId }}' --required
AND region = '{{ region }}' --required
AND if-match = '{{ if-match}}'
RETURNING
sharedSecret;