Oracle Cloud Infrastructure Documentation
Try Free Tier

Bastion Common Types

DBMS_CLOUD_OCI_BASTION_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_BASTION_BASTION_T Type

A bastion resource. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. A bastion resides in a public subnet and establishes the network infrastructure needed to connect a user to a target resource in a private subnet.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_bastion_t FORCE AUTHID CURRENT_USER IS OBJECT (
  bastion_type varchar2(32767),
  id varchar2(32767),
  name varchar2(32767),
  compartment_id varchar2(32767),
  target_vcn_id varchar2(32767),
  target_subnet_id varchar2(32767),
  phone_book_entry varchar2(32767),
  client_cidr_block_allow_list dbms_cloud_oci_bastion_varchar2_tbl,
  static_jump_host_ip_addresses dbms_cloud_oci_bastion_varchar2_tbl,
  private_endpoint_ip_address varchar2(32767),
  max_session_ttl_in_seconds number,
  max_sessions_allowed number,
  dns_proxy_status varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_bastion_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_bastion_t (
    bastion_type varchar2,
    id varchar2,
    name varchar2,
    compartment_id varchar2,
    target_vcn_id varchar2,
    target_subnet_id varchar2,
    phone_book_entry varchar2,
    client_cidr_block_allow_list dbms_cloud_oci_bastion_varchar2_tbl,
    static_jump_host_ip_addresses dbms_cloud_oci_bastion_varchar2_tbl,
    private_endpoint_ip_address varchar2,
    max_session_ttl_in_seconds number,
    max_sessions_allowed number,
    dns_proxy_status varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

bastion_type

(required) The type of bastion.

id

(required) The unique identifier (OCID) of the bastion, which can't be changed after creation.

name

(required) The name of the bastion, which can't be changed after creation.

compartment_id

(required) The unique identifier (OCID) of the compartment where the bastion is located.

target_vcn_id

(required) The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.

target_subnet_id

(required) The unique identifier (OCID) of the subnet that the bastion connects to.

phone_book_entry

(optional) The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to `standard` bastions.

client_cidr_block_allow_list

(optional) A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.

static_jump_host_ip_addresses

(optional) A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions.

private_endpoint_ip_address

(optional) The private IP address of the created private endpoint.

max_session_ttl_in_seconds

(required) The maximum amount of time that any session on the bastion can remain active.

max_sessions_allowed

(optional) The maximum number of active sessions allowed on the bastion.

dns_proxy_status

(optional) The current dns proxy status of the bastion.

Allowed values are: 'DISABLED', 'ENABLED'

time_created

(required) The time the bastion was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

time_updated

(optional) The time the bastion was updated. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

lifecycle_state

(required) The current state of the bastion.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

lifecycle_details

(optional) A message describing the current state in more detail.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_BASTION_BASTION_SUMMARY_T Type

Summary information for a bastion resource. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. A bastion resides in a public subnet and establishes the network infrastructure needed to connect a user to a target resource in a private subnet.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_bastion_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  bastion_type varchar2(32767),
  id varchar2(32767),
  name varchar2(32767),
  compartment_id varchar2(32767),
  target_vcn_id varchar2(32767),
  target_subnet_id varchar2(32767),
  dns_proxy_status varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_bastion_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_bastion_summary_t (
    bastion_type varchar2,
    id varchar2,
    name varchar2,
    compartment_id varchar2,
    target_vcn_id varchar2,
    target_subnet_id varchar2,
    dns_proxy_status varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

bastion_type

(required) The type of bastion.

id

(required) The unique identifier (OCID) of the bastion, which can't be changed after creation.

name

(required) The name of the bastion, which can't be changed after creation.

compartment_id

(required) The unique identifier (OCID) of the compartment where the bastion is located.

target_vcn_id

(required) The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.

target_subnet_id

(required) The unique identifier (OCID) of the subnet that the bastion connects to.

dns_proxy_status

(optional) The current dns proxy status of the bastion.

Allowed values are: 'DISABLED', 'ENABLED'

time_created

(required) The time the bastion was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

time_updated

(optional) The time the bastion was updated. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

lifecycle_state

(required) The current state of the bastion.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

lifecycle_details

(optional) A message describing the current state in more detail.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_BASTION_CHANGE_BASTION_COMPARTMENT_DETAILS_T Type

Details about the compartment that the bastion should move to.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_change_bastion_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_change_bastion_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_change_bastion_compartment_details_t (
    compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) The unique identifier (OCID) of the compartment that the bastion should move to.

DBMS_CLOUD_OCI_BASTION_CREATE_BASTION_DETAILS_T Type

The configuration details for a new bastion. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. A bastion resides in a public subnet and establishes the network infrastructure needed to connect a user to a target resource in a private subnet.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_create_bastion_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  bastion_type varchar2(32767),
  name varchar2(32767),
  compartment_id varchar2(32767),
  target_subnet_id varchar2(32767),
  phone_book_entry varchar2(32767),
  static_jump_host_ip_addresses dbms_cloud_oci_bastion_varchar2_tbl,
  client_cidr_block_allow_list dbms_cloud_oci_bastion_varchar2_tbl,
  max_session_ttl_in_seconds number,
  dns_proxy_status varchar2(32767),
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_bastion_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_bastion_details_t (
    bastion_type varchar2,
    name varchar2,
    compartment_id varchar2,
    target_subnet_id varchar2,
    phone_book_entry varchar2,
    static_jump_host_ip_addresses dbms_cloud_oci_bastion_varchar2_tbl,
    client_cidr_block_allow_list dbms_cloud_oci_bastion_varchar2_tbl,
    max_session_ttl_in_seconds number,
    dns_proxy_status varchar2,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

bastion_type

(required) The type of bastion. Use `standard`.

name

(optional) The name of the bastion, which can't be changed after creation.

compartment_id

(required) The unique identifier (OCID) of the compartment where the bastion is located.

target_subnet_id

(required) The unique identifier (OCID) of the subnet that the bastion connects to.

phone_book_entry

(optional) The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to `standard` bastions.

static_jump_host_ip_addresses

(optional) A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions.

client_cidr_block_allow_list

(optional) A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.

max_session_ttl_in_seconds

(optional) The maximum amount of time that any session on the bastion can remain active.

dns_proxy_status

(optional) The desired dns proxy status of the bastion.

Allowed values are: 'DISABLED', 'ENABLED'

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_BASTION_CREATE_SESSION_TARGET_RESOURCE_DETAILS_T Type

Details about a bastion session's target resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_create_session_target_resource_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  session_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_session_target_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_session_target_resource_details_t (
    session_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

session_type

(required) The session type.

Allowed values are: 'MANAGED_SSH', 'PORT_FORWARDING', 'DYNAMIC_PORT_FORWARDING'

DBMS_CLOUD_OCI_BASTION_CREATE_DYNAMIC_PORT_FORWARDING_SESSION_TARGET_RESOURCE_DETAILS_T Type

Details about a dynamic port forwarding session for a target subnet.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_create_dynamic_port_forwarding_session_target_resource_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bastion_create_session_target_resource_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_dynamic_port_forwarding_session_target_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_dynamic_port_forwarding_session_target_resource_details_t (
    session_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bastion_create_dynamic_port_forwarding_session_target_resource_details_t is a subtype of the dbms_cloud_oci_bastion_create_session_target_resource_details_t type.

DBMS_CLOUD_OCI_BASTION_CREATE_MANAGED_SSH_SESSION_TARGET_RESOURCE_DETAILS_T Type

Details about a managed SSH session for a target resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_create_managed_ssh_session_target_resource_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bastion_create_session_target_resource_details_t (
  target_resource_operating_system_user_name varchar2(32767),
  target_resource_id varchar2(32767),
  target_resource_private_ip_address varchar2(32767),
  target_resource_port number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_managed_ssh_session_target_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_managed_ssh_session_target_resource_details_t (
    session_type varchar2,
    target_resource_operating_system_user_name varchar2,
    target_resource_id varchar2,
    target_resource_private_ip_address varchar2,
    target_resource_port number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bastion_create_managed_ssh_session_target_resource_details_t is a subtype of the dbms_cloud_oci_bastion_create_session_target_resource_details_t type.

Fields

Field Description

target_resource_operating_system_user_name

(required) The name of the user on the target resource operating system that the session uses for the connection.

target_resource_id

(required) The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.

target_resource_private_ip_address

(optional) The private IP address of the target resource that the session connects to.

target_resource_port

(optional) The port number to connect to on the target resource.

DBMS_CLOUD_OCI_BASTION_CREATE_PORT_FORWARDING_SESSION_TARGET_RESOURCE_DETAILS_T Type

Details about a port forwarding session for a target resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_create_port_forwarding_session_target_resource_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bastion_create_session_target_resource_details_t (
  target_resource_id varchar2(32767),
  target_resource_private_ip_address varchar2(32767),
  target_resource_fqdn varchar2(32767),
  target_resource_port number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_port_forwarding_session_target_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_port_forwarding_session_target_resource_details_t (
    session_type varchar2,
    target_resource_id varchar2,
    target_resource_private_ip_address varchar2,
    target_resource_fqdn varchar2,
    target_resource_port number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bastion_create_port_forwarding_session_target_resource_details_t is a subtype of the dbms_cloud_oci_bastion_create_session_target_resource_details_t type.

Fields

Field Description

target_resource_id

(optional) The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.

target_resource_private_ip_address

(optional) The private IP address of the target resource that the session connects to.

target_resource_fqdn

(optional) The Fully Qualified Domain Name of the target resource that the session connects to.

target_resource_port

(optional) The port number to connect to on the target resource.

DBMS_CLOUD_OCI_BASTION_PUBLIC_KEY_DETAILS_T Type

Public key details for a bastion session.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_public_key_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  public_key_content varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_public_key_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_public_key_details_t (
    public_key_content varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

public_key_content

(required) The public key in OpenSSH format of the SSH key pair for the session. When you connect to the session, you must provide the private key of the same SSH key pair.

DBMS_CLOUD_OCI_BASTION_CREATE_SESSION_DETAILS_T Type

The configuration details for a new bastion session. A session lets authorized users connect to a target resource for a predetermined amount of time. The Bastion service recognizes two types of sessions, managed SSH sessions and SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_create_session_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  bastion_id varchar2(32767),
  target_resource_details dbms_cloud_oci_bastion_create_session_target_resource_details_t,
  key_type varchar2(32767),
  key_details dbms_cloud_oci_bastion_public_key_details_t,
  session_ttl_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_session_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_create_session_details_t (
    display_name varchar2,
    bastion_id varchar2,
    target_resource_details dbms_cloud_oci_bastion_create_session_target_resource_details_t,
    key_type varchar2,
    key_details dbms_cloud_oci_bastion_public_key_details_t,
    session_ttl_in_seconds number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The name of the session.

bastion_id

(required) The unique identifier (OCID) of the bastion on which to create this session.

target_resource_details

(required)

key_type

(optional) The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.

Allowed values are: 'PUB'

key_details

(required)

session_ttl_in_seconds

(optional) The amount of time the session can remain active.

DBMS_CLOUD_OCI_BASTION_TARGET_RESOURCE_DETAILS_T Type

Details about a bastion session's target resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_target_resource_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  session_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_target_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_target_resource_details_t (
    session_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE NOT FINAL;

Fields

Field Description

session_type

(required) The Bastion service recognizes three types of sessions, managed SSH sessions, SSH port forwarding sessions, and Dynamic SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.

Allowed values are: 'MANAGED_SSH', 'PORT_FORWARDING', 'DYNAMIC_PORT_FORWARDING'

DBMS_CLOUD_OCI_BASTION_DYNAMIC_PORT_FORWARDING_SESSION_TARGET_RESOURCE_DETAILS_T Type

Details about a dynamic port forwarding session for a target subnet.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_dynamic_port_forwarding_session_target_resource_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bastion_target_resource_details_t (
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_dynamic_port_forwarding_session_target_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_dynamic_port_forwarding_session_target_resource_details_t (
    session_type varchar2
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bastion_dynamic_port_forwarding_session_target_resource_details_t is a subtype of the dbms_cloud_oci_bastion_target_resource_details_t type.

DBMS_CLOUD_OCI_BASTION_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_BASTION_MANAGED_SSH_SESSION_TARGET_RESOURCE_DETAILS_T Type

Details about a managed SSH session for a target resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_managed_ssh_session_target_resource_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bastion_target_resource_details_t (
  target_resource_operating_system_user_name varchar2(32767),
  target_resource_id varchar2(32767),
  target_resource_private_ip_address varchar2(32767),
  target_resource_display_name varchar2(32767),
  target_resource_port number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_managed_ssh_session_target_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_managed_ssh_session_target_resource_details_t (
    session_type varchar2,
    target_resource_operating_system_user_name varchar2,
    target_resource_id varchar2,
    target_resource_private_ip_address varchar2,
    target_resource_display_name varchar2,
    target_resource_port number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bastion_managed_ssh_session_target_resource_details_t is a subtype of the dbms_cloud_oci_bastion_target_resource_details_t type.

Fields

Field Description

target_resource_operating_system_user_name

(required) The name of the user on the target resource operating system that the session uses for the connection.

target_resource_id

(required) The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.

target_resource_private_ip_address

(optional) The private IP address of the target resource that the session connects to.

target_resource_display_name

(required) The display name of the target Compute instance that the session connects to.

target_resource_port

(optional) The port number to connect to on the target resource.

DBMS_CLOUD_OCI_BASTION_PORT_FORWARDING_SESSION_TARGET_RESOURCE_DETAILS_T Type

Details about a port forwarding session for a target resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_port_forwarding_session_target_resource_details_t FORCE AUTHID CURRENT_USER UNDER dbms_cloud_oci_bastion_target_resource_details_t (
  target_resource_id varchar2(32767),
  target_resource_private_ip_address varchar2(32767),
  target_resource_display_name varchar2(32767),
  target_resource_fqdn varchar2(32767),
  target_resource_port number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_port_forwarding_session_target_resource_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_port_forwarding_session_target_resource_details_t (
    session_type varchar2,
    target_resource_id varchar2,
    target_resource_private_ip_address varchar2,
    target_resource_display_name varchar2,
    target_resource_fqdn varchar2,
    target_resource_port number
  ) RETURN SELF AS RESULT
);

dbms_cloud_oci_bastion_port_forwarding_session_target_resource_details_t is a subtype of the dbms_cloud_oci_bastion_target_resource_details_t type.

Fields

Field Description

target_resource_id

(optional) The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.

target_resource_private_ip_address

(optional) The private IP address of the target resource that the session connects to.

target_resource_display_name

(optional) The display name of the target Compute instance that the session connects to.

target_resource_fqdn

(optional) The Fully Qualified Domain Name of the target resource that the session connects to.

target_resource_port

(optional) The port number to connect to on the target resource.

DBMS_CLOUD_OCI_BASTION_SESSION_T Type

A bastion session resource. A bastion session lets authorized users connect to a target resource using a Secure Shell (SSH) for a predetermined amount of time.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_session_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  bastion_id varchar2(32767),
  bastion_name varchar2(32767),
  bastion_user_name varchar2(32767),
  target_resource_details dbms_cloud_oci_bastion_target_resource_details_t,
  ssh_metadata json_element_t,
  key_type varchar2(32767),
  key_details dbms_cloud_oci_bastion_public_key_details_t,
  bastion_public_host_key_info varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  session_ttl_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_session_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_session_t (
    id varchar2,
    display_name varchar2,
    bastion_id varchar2,
    bastion_name varchar2,
    bastion_user_name varchar2,
    target_resource_details dbms_cloud_oci_bastion_target_resource_details_t,
    ssh_metadata json_element_t,
    key_type varchar2,
    key_details dbms_cloud_oci_bastion_public_key_details_t,
    bastion_public_host_key_info varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    session_ttl_in_seconds number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The unique identifier (OCID) of the session, which can't be changed after creation.

display_name

(optional) The name of the session.

bastion_id

(required) The unique identifier (OCID) of the bastion that is hosting this session.

bastion_name

(required) The name of the bastion that is hosting this session.

bastion_user_name

(optional) The username that the session uses to connect to the target resource.

target_resource_details

(required)

ssh_metadata

(optional) The connection message for the session.

key_type

(optional) The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.

Allowed values are: 'PUB'

key_details

(required)

bastion_public_host_key_info

(optional) The public key of the bastion host. You can use this to verify that you're connecting to the correct bastion.

time_created

(required) The time the session was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

time_updated

(optional) The time the session was updated. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

lifecycle_state

(required) The current state of the session.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

lifecycle_details

(optional) A message describing the current session state in more detail.

session_ttl_in_seconds

(required) The amount of time the session can remain active.

DBMS_CLOUD_OCI_BASTION_SESSION_SUMMARY_T Type

Summary information for a bastion session resource.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_session_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  display_name varchar2(32767),
  bastion_name varchar2(32767),
  bastion_id varchar2(32767),
  target_resource_details dbms_cloud_oci_bastion_target_resource_details_t,
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  session_ttl_in_seconds number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_session_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_session_summary_t (
    id varchar2,
    display_name varchar2,
    bastion_name varchar2,
    bastion_id varchar2,
    target_resource_details dbms_cloud_oci_bastion_target_resource_details_t,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    session_ttl_in_seconds number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) The unique identifier (OCID) of the session, which can't be changed after creation.

display_name

(optional) The name of the session.

bastion_name

(required) The name of the bastion that is hosting this session.

bastion_id

(required) The unique identifier (OCID) of the bastion that is hosting this session.

target_resource_details

(required)

time_created

(required) The time the session was created. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

time_updated

(optional) The time the session was updated. Format is defined by RFC3339. Example: `2020-01-25T21:10:29.600Z`

lifecycle_state

(required) The current state of the session.

Allowed values are: 'CREATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

lifecycle_details

(optional) A message describing the current session state in more detail.

session_ttl_in_seconds

(required) The amount of time the session can remain active.

DBMS_CLOUD_OCI_BASTION_UPDATE_BASTION_DETAILS_T Type

The configuration to update on an existing bastion.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_update_bastion_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  max_session_ttl_in_seconds number,
  static_jump_host_ip_addresses dbms_cloud_oci_bastion_varchar2_tbl,
  client_cidr_block_allow_list dbms_cloud_oci_bastion_varchar2_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_update_bastion_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_update_bastion_details_t (
    max_session_ttl_in_seconds number,
    static_jump_host_ip_addresses dbms_cloud_oci_bastion_varchar2_tbl,
    client_cidr_block_allow_list dbms_cloud_oci_bastion_varchar2_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

max_session_ttl_in_seconds

(optional) The maximum amount of time that any session on the bastion can remain active.

static_jump_host_ip_addresses

(optional) A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions.

client_cidr_block_allow_list

(optional) A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_BASTION_UPDATE_SESSION_DETAILS_T Type

The session information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_update_session_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  display_name varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_update_session_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_update_session_details_t (
    display_name varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

display_name

(optional) The name of the session.

DBMS_CLOUD_OCI_BASTION_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  entity_type varchar2(32767),
  action_type varchar2(32767),
  identifier varchar2(32767),
  entity_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

entity_type

(required) The resource type the work request affects.

action_type

(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS', 'RELATED'

identifier

(required) The unique identifier (OCID) of the resource that the work request affects.

entity_uri

(optional) The URI path that the user can do a GET on to access the resource metadata.

DBMS_CLOUD_OCI_BASTION_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_bastion_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_bastion_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_BASTION_WORK_REQUEST_T Type

A description of workrequest status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_bastion_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_bastion_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request.

Allowed values are: 'CREATE_BASTION', 'UPDATE_BASTION', 'DELETE_BASTION', 'CREATE_SESSION', 'DELETE_SESSION'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The unique identifier (OCID) of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_BASTION_WORK_REQUEST_ERROR_T Type

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A machine-usable code for the error that occurred. Error codes are listed on (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)

message

(required) A human readable description of the issue encountered.

l_timestamp

(required) The time the error occurred. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_BASTION_WORK_REQUEST_LOG_ENTRY_T Type

A log message from the execution of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_log_entry_t (
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

message

(required) Human-readable log message.

l_timestamp

(required) The time the log message was written. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_BASTION_WORK_REQUEST_SUMMARY_T Type

A description of workrequest status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_bastion_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_bastion_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_bastion_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_bastion_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request.

Allowed values are: 'CREATE_BASTION', 'UPDATE_BASTION', 'DELETE_BASTION', 'CREATE_SESSION', 'DELETE_SESSION'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The unique identifier (OCID) of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request. Work requests should be scoped to the same compartment as the resource the work request affects. If the work request affects multiple resources, and those resources are not in the same compartment, it is up to the service team to pick the primary resource whose compartment should be used

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

Was this article helpful?