create

Description

Create an VM instance on Database Infrastructure using the specified details.

Usage

oci datacc vm-instance create [OPTIONS]

Required Parameters

--compartment-id, -c [text]

The OCID of the compartment containing the VM instance.

--cpus-enabled [integer]

The number of CPU cores enabled for each VM instance.

--infrastructure-id [text]

The OCID of the Database Infrastructure.

--ssh-public-keys [complex type]

List of public key used for SSH access to the VM instance. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

Optional Parameters

--boot-storage-size-in-gbs [text]

Boot storage memory to be allocated in GBs.

--data-storage-size-in-gbs [text]

Data storage to be allocated in GBs.

--defined-tags [complex type]

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}} This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--description [text]

VM instance description.

--display-name [text]

VM instance display name. This name does not have to be unique, and is changeable.

--dns-servers [complex type]

The list of DNS server IP addresses. Maximum of 3 allowed. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--domain-name [text]

The domain name of the VM instance.

--freeform-tags [complex type]

Simple key-value pair that is applied without any predefined name, type or scope. This tag option exists for cross-compatibility only. Example: {“bar-key”: “value”} This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Content/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--gateway [text]

The gateway IP address of the VM instance network

--hostname [text]

The host name of the instance.

--image-id [text]

The OCID of the VM custom instance uploaded.

--ip-address [text]

The IP address of the instance.

--max-wait-seconds [integer]

The maximum time to wait for the work request to reach the state defined by --wait-for-state. Defaults to 1200 seconds.

--memory-size-in-gbs [text]

The memory to be allocated in GBs.

--metadata [complex type]

Custom metadata key/value pairs which can be used to: - Provide information to Cloud-Init to be used for various system initialization tasks. - Provide additional information which is exposed inside the instance context and can be queried or referenced by user-data scripts for dynamic configuration. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--netmask [text]

The netmask of the VM instance network.

--ntp-servers [complex type]

The list of NTP server IP addresses. Maximum of 3 allowed. This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--server-id [text]

The OCID of the compute node on which VM instance should be launched.

--system-tags [complex type]

Usage of system tag keys. These predefined keys are scoped to namespaces. Example: { “orcl-cloud”: { “free-tier-retained”: “true” } } This is a complex type whose value must be valid JSON. The value can be provided as a string on the command line or passed in as a file using the file://path/to/file syntax.

The --generate-param-json-input option can be used to generate an example of the JSON which must be provided. We recommend storing this example in a file, modifying it as needed and then passing it back in via the file:// syntax.

--time-zone [text]

The time zone to use for the VM instance.

--userdata [text]

Base64-encoded data to be used by Cloud-Init to run custom scripts or provide custom Cloud-Init configuration. For information about how to take advantage of user data, see the Cloud-Init Documentation.

--vlan-id [text]

The network VLAN ID.

--vm-network-id [text]

The OCID of the VM Network.

--wait-for-state [text]

This operation asynchronously creates, modifies or deletes a resource and uses a work request to track the progress of the operation. Specify this option to perform the action and then wait until the work request reaches a certain state. Multiple states can be specified, returning on the first state. For example, --wait-for-state ACCEPTED --wait-for-state WAITING would return on whichever lifecycle state is reached first. If timeout is reached, a return code of 2 is returned. For any other error, a return code of 1 is returned.

Accepted values are:

ACCEPTED, CANCELED, CANCELING, FAILED, IN_PROGRESS, SUCCEEDED, WAITING
--wait-interval-seconds [integer]

Check every --wait-interval-seconds to see whether the work request has reached the state defined by --wait-for-state. Defaults to 30 seconds.

Example using required parameter

Copy and paste the following example into a JSON file, replacing the example parameters with your own.

    oci datacc infrastructure create --generate-param-json-input dns-servers > dns-servers.json
    oci datacc infrastructure create --generate-param-json-input ntp-servers > ntp-servers.json

    oci datacc vm-instance create --generate-param-json-input ssh-public-keys > ssh-public-keys.json

Copy the following CLI commands into a file named example.sh. Run the command by typing “bash example.sh” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-compartment-id
    export control_plane_server1=<substitute-value-of-control_plane_server1> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-control-plane-server1
    export control_plane_server2=<substitute-value-of-control_plane_server2> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-control-plane-server2
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-display-name
    export gateway=<substitute-value-of-gateway> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-gateway
    export netmask=<substitute-value-of-netmask> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-netmask
    export shape=<substitute-value-of-shape> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-shape
    export system_model=<substitute-value-of-system_model> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/infrastructure/create.html#cmdoption-system-model
    export cpus_enabled=<substitute-value-of-cpus_enabled> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/datacc/vm-instance/create.html#cmdoption-cpus-enabled

    infrastructure_id=$(oci datacc infrastructure create --compartment-id $compartment_id --control-plane-server1 $control_plane_server1 --control-plane-server2 $control_plane_server2 --display-name $display_name --dns-servers file://dns-servers.json --gateway $gateway --netmask $netmask --ntp-servers file://ntp-servers.json --shape $shape --system-model $system_model --query data.id --raw-output)

    oci datacc vm-instance create --compartment-id $compartment_id --cpus-enabled $cpus_enabled --infrastructure-id $infrastructure_id --ssh-public-keys file://ssh-public-keys.json