create

Description

Creates an asset source.

Usage

oci cloud-bridge discovery asset-source create [OPTIONS]

Required Parameters

--assets-compartment-id [text]

The OCID of the compartment that is going to be used to create assets.

--compartment-id, -c [text]

The OCID of the compartment for the resource.

--environment-id [text]

The OCID of the environment.

--inventory-id [text]

The OCID of the inventory that will contain created assets.

--type [text]

Asset source type.

Accepted values are:

AWS, VMWARE

Optional Parameters

--are-historical-metrics-collected [boolean]

Flag indicating whether historical metrics are collected for assets, originating from this asset source.

--are-realtime-metrics-collected [boolean]

Flag indicating whether real-time metrics are collected for assets, originating from this asset source.

--aws-account-key [text]

The key of customer’s aws account to be discovered/migrated.

--aws-region [text]

AWS region information, from where the resources are discovered.

--defined-tags [complex type]

The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {“Operations”: {“CostCenter”: “42”}} 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.

--discovery-credentials [complex type]

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.

--discovery-schedule-id [text]

The OCID of the discovery schedule that is going to be attached to the created asset.

--display-name [text]

A user-friendly name for the asset source. Does not have to be unique, and it’s mutable. Avoid entering confidential information. The name is generated by the service if it is not explicitly provided.

--freeform-tags [complex type]

The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see Resource Tags. Example: {“Department”: “Finance”} 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

--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

--is-cost-information-collected [boolean]

Flag indicating whether cost data collection is enabled for assets, originating from this asset source.

--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.

--system-tags [complex type]

The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags. Example: {orcl-cloud: {free-tier-retain: 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.

--vcenter-endpoint [text]

Endpoint for VMware asset discovery and replication in the form of `https://<host>:<port>/sdk`

--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 SUCCEEDED --wait-for-state FAILED 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 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/cloud-bridge/inventory/inventory/create.html#cmdoption-compartment-id
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-bridge/inventory/inventory/create.html#cmdoption-display-name
    export assets_compartment_id=<substitute-value-of-assets_compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-bridge/discovery/asset-source/create.html#cmdoption-assets-compartment-id
    export type=<substitute-value-of-type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-bridge/discovery/asset-source/create.html#cmdoption-type

    environment_id=$(oci cloud-bridge ocb-agent-svc environment create --compartment-id $compartment_id --query data.id --raw-output)

    inventory_id=$(oci cloud-bridge inventory inventory create --compartment-id $compartment_id --display-name $display_name --query data.id --raw-output)

    oci cloud-bridge discovery asset-source create --assets-compartment-id $assets_compartment_id --compartment-id $compartment_id --environment-id $environment_id --inventory-id $inventory_id --type $type