create-with-oracle-rm-stack
¶
Description¶
Registers a new dedicated vantage point.
Required Parameters¶
-
--apm-domain-id
[text]
¶
The APM domain ID the request is intended for.
-
--display-name
[text]
¶
Unique dedicated vantage point name that cannot be edited. The name should not contain any confidential information.
-
--dvp-region
[text]
¶
Name of the region.
-
--dvp-stack-details-dvp-stack-id
[text]
¶
Stack OCID of the Resource Manager stack for dedicated vantage point.
-
--dvp-stack-details-dvp-stream-id
[text]
¶
Stream OCID of the Resource Manager stack for dedicated vantage point.
-
--dvp-stack-details-dvp-version
[text]
¶
Version of the dedicated vantage point.
Optional Parameters¶
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.
Simple key-value pair that is applied without any predefined name, type or scope. 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
-
--status
[text]
¶
Status of the dedicated vantage point.
Accepted values are:
DISABLED, ENABLED
Global Parameters¶
Use oci --help
for help on global parameters.
--auth-purpose
, --auth
, --cert-bundle
, --cli-auto-prompt
, --cli-rc-file
, --config-file
, --connection-timeout
, --debug
, --defaults-file
, --endpoint
, --generate-full-command-json-input
, --generate-param-json-input
, --help
, --latest-version
, --max-retries
, --no-retry
, --opc-client-request-id
, --opc-request-id
, --output
, --profile
, --proxy
, --query
, --raw-output
, --read-timeout
, --realm-specific-endpoint
, --region
, --release-info
, --request-id
, --version
, -?
, -d
, -h
, -i
, -v
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 apm_domain_id=<substitute-value-of-apm_domain_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/apm-synthetics/dedicated-vantage-point/create-with-oracle-rm-stack.html#cmdoption-apm-domain-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/apm-synthetics/dedicated-vantage-point/create-with-oracle-rm-stack.html#cmdoption-display-name
export dvp_region=<substitute-value-of-dvp_region> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/apm-synthetics/dedicated-vantage-point/create-with-oracle-rm-stack.html#cmdoption-dvp-region
export dvp_stack_details_dvp_stack_id=<substitute-value-of-dvp_stack_details_dvp_stack_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/apm-synthetics/dedicated-vantage-point/create-with-oracle-rm-stack.html#cmdoption-dvp-stack-details-dvp-stack-id
export dvp_stack_details_dvp_stream_id=<substitute-value-of-dvp_stack_details_dvp_stream_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/apm-synthetics/dedicated-vantage-point/create-with-oracle-rm-stack.html#cmdoption-dvp-stack-details-dvp-stream-id
export dvp_stack_details_dvp_version=<substitute-value-of-dvp_stack_details_dvp_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/apm-synthetics/dedicated-vantage-point/create-with-oracle-rm-stack.html#cmdoption-dvp-stack-details-dvp-version
oci apm-synthetics dedicated-vantage-point create-with-oracle-rm-stack --apm-domain-id $apm_domain_id --display-name $display_name --dvp-region $dvp_region --dvp-stack-details-dvp-stack-id $dvp_stack_details_dvp_stack_id --dvp-stack-details-dvp-stream-id $dvp_stack_details_dvp_stream_id --dvp-stack-details-dvp-version $dvp_stack_details_dvp_version