list

Description

List Blockchain Platform Peers

Usage

oci blockchain peer list [OPTIONS]

Required Parameters

--blockchain-platform-id [text]

Unique service identifier.

Optional Parameters

--all

Fetches all pages of results. If you provide this option, then you cannot provide the --limit option.

--display-name [text]

A user-friendly name. Does not have to be unique, and it’s changeable. Example: My new resource

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

--limit [integer]

The maximum number of items to return.

--page [text]

The page at which to start retrieving results.

--page-size [integer]

When fetching results, the number of results to fetch per call. Only valid when used with --all or --limit, and ignored otherwise.

--sort-by [text]

The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

Accepted values are:

displayName, timeCreated
--sort-order [text]

The sort order to use, either ‘asc’ or ‘desc’.

Accepted values are:

ASC, DESC

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/blockchain/blockchain-platform/create.html#cmdoption-compartment-id
    export compute_shape=<substitute-value-of-compute_shape> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/blockchain/blockchain-platform/create.html#cmdoption-compute-shape
    export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/blockchain/blockchain-platform/create.html#cmdoption-display-name
    export idcs_access_token=<substitute-value-of-idcs_access_token> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/blockchain/blockchain-platform/create.html#cmdoption-idcs-access-token
    export platform_role=<substitute-value-of-platform_role> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/blockchain/blockchain-platform/create.html#cmdoption-platform-role

    blockchain_platform_id=$(oci blockchain blockchain-platform create --compartment-id $compartment_id --compute-shape $compute_shape --display-name $display_name --idcs-access-token $idcs_access_token --platform-role $platform_role --query data.id --raw-output)

    oci blockchain peer list --blockchain-platform-id $blockchain_platform_id