create
¶
Description¶
Create a product, environment, group, or generic type of fleet in Fleet Application Management.
Required Parameters¶
-
--compartment-id
,
-c
[text]
¶
Tenancy OCID
-
--fleet-type
[text]
¶
Type of the Fleet. PRODUCT - A fleet of product-specific resources for a product type. ENVIRONMENT - A fleet of environment-specific resources for a product stack. GROUP - A fleet of a fleet of either environment or product fleets. GENERIC - A fleet of resources selected dynamically or manually for reporting purposes
Optional Parameters¶
-
--application-type
[text]
¶
Product stack associated with the Fleet. Applicable for ENVIRONMENT fleet types.
-
--credentials
[complex type]
¶
Credentials associated with the Fleet.
This option is a JSON list with items of type AssociatedFleetCredentialDetails. For documentation on AssociatedFleetCredentialDetails please see our API reference: https://docs.cloud.oracle.com/api/#/en/fleetappsmanagement/20230831/datatypes/AssociatedFleetCredentialDetails. 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.
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]
¶
A user-friendly description. To provide some insight about the resource. Avoid entering confidential information.
-
--display-name
[text]
¶
A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
Example:
My new resource
-
--environment-type
[text]
¶
Environment Type associated with the Fleet. Applicable for ENVIRONMENT fleet types.
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
-
--group-type
[text]
¶
Group Type associated with Group Fleet.
-
--is-target-auto-confirm
[boolean]
¶
A value that represents if auto-confirming of the targets can be enabled. This will allow targets to be auto-confirmed in the fleet without manual intervention.
-
--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.
-
--notification-preferences
[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.
-
--products
[complex type]
¶
Products associated with the Fleet. 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.
-
--resource-selection-type
[text]
¶
Type of resource selection in a Fleet. Select resources manually or select resources based on rules.
-
--resources
[complex type]
¶
Resources associated with the Fleet if resourceSelectionType is MANUAL.
This option is a JSON list with items of type AssociatedFleetResourceDetails. For documentation on AssociatedFleetResourceDetails please see our API reference: https://docs.cloud.oracle.com/api/#/en/fleetappsmanagement/20230831/datatypes/AssociatedFleetResourceDetails. 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.
-
--rule-selection-criteria
[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.
-
--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, NEEDS_ATTENTION, 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.
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 compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/fleet-apps-management/fleet/create.html#cmdoption-compartment-id
export fleet_type=<substitute-value-of-fleet_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/fleet-apps-management/fleet/create.html#cmdoption-fleet-type
oci fleet-apps-management fleet create --compartment-id $compartment_id --fleet-type $fleet_type