update

Description

Updates the plugin.

Usage

oci cloud-bridge ocb-agent-svc plugin update [OPTIONS]

Required Parameters

--agent-id [text]

Unique Agent identifier path parameter.

--desired-state [text]

State to which the customer wants the plugin to move to.

--plugin-name [text]

Unique plugin identifier path parameter.

Optional Parameters

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

--if-match [text]

For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.

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

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

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/cloud-bridge/ocb-agent-svc/environment/create.html#cmdoption-compartment-id
    export agent_type=<substitute-value-of-agent_type> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-bridge/ocb-agent-svc/agent/create.html#cmdoption-agent-type
    export agent_version=<substitute-value-of-agent_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-bridge/ocb-agent-svc/agent/create.html#cmdoption-agent-version
    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/ocb-agent-svc/agent/create.html#cmdoption-display-name
    export os_version=<substitute-value-of-os_version> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-bridge/ocb-agent-svc/agent/create.html#cmdoption-os-version
    export desired_state=<substitute-value-of-desired_state> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-bridge/ocb-agent-svc/plugin/update.html#cmdoption-desired-state
    export plugin_name=<substitute-value-of-plugin_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/cloud-bridge/ocb-agent-svc/plugin/update.html#cmdoption-plugin-name

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

    agent_id=$(oci cloud-bridge ocb-agent-svc agent create --agent-type $agent_type --agent-version $agent_version --compartment-id $compartment_id --display-name $display_name --environment-id $environment_id --os-version $os_version --query data.id --raw-output)

    oci cloud-bridge ocb-agent-svc plugin update --agent-id $agent_id --desired-state $desired_state --plugin-name $plugin_name