oracle.oci.oci_blockchain_platform – Manage a BlockchainPlatform resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_blockchain_platform.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a BlockchainPlatform resource in Oracle Cloud Infrastructure

  • For state=present, creates a new Blockchain Platform.

  • This resource has the following action operations in the oracle.oci.oci_blockchain_platform_actions module: change_compartment, start, stop, upgrade.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
blockchain_platform_id
string
Unique service identifier.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
ca_cert_archive_text
string
Base64 encoded text in ASCII character set of a Thirdparty CA Certificates archive file. The Archive file is a zip file containing third part CA Certificates, the ca key and certificate files used when issuing enrollment certificates (ECerts) and transaction certificates (TCerts). The chainfile (if it exists) contains the certificate chain which should be trusted for this CA, where the 1st in the chain is always the root CA certificate. File list in zip file [ca-cert.pem,ca-key.pem,ca-chain.pem(optional)].
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
Compartment Identifier
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
compute_shape
string
Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE
Required for create using state=present.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
This parameter is updatable.
description
string
Platform Instance Description
This parameter is updatable.
display_name
string
Platform Instance Display name, can be renamed
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.

aliases: name
federated_user_id
string
Identifier for a federated user
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`
This parameter is updatable.
idcs_access_token
string
IDCS access token with Identity Domain Administrator role
Required for create using state=present.
is_byol
boolean
    Choices:
  • no
  • yes
Bring your own license
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
load_balancer_shape
string
Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS.
This parameter is updatable.
platform_role
string
Role of platform - founder or participant
Required for create using state=present.
platform_version
string
Platform version
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
replicas
dictionary
This parameter is updatable.
ca_count
integer
Number of CA replicas
This parameter is updatable.
console_count
integer
Number of console replicas
This parameter is updatable.
proxy_count
integer
Number of REST proxy replicas
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the BlockchainPlatform.
Use state=present to create or update a BlockchainPlatform.
Use state=absent to delete a BlockchainPlatform.
storage_size_in_tbs
float
Storage size in TBs
This parameter is updatable.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
total_ocpu_capacity
integer
Number of total OCPUs to allocate
This parameter is updatable.
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create blockchain_platform
  oci_blockchain_platform:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    platform_role: platform_role_example
    compute_shape: compute_shape_example
    idcs_access_token: idcs_access_token_example

    # optional
    is_byol: true
    platform_version: platform_version_example
    federated_user_id: "ocid1.federateduser.oc1..xxxxxxEXAMPLExxxxxx"
    ca_cert_archive_text: ca_cert_archive_text_example
    description: description_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update blockchain_platform
  oci_blockchain_platform:
    # required
    blockchain_platform_id: "ocid1.blockchainplatform.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    description: description_example
    storage_size_in_tbs: 3.4
    replicas:
      # optional
      proxy_count: 56
      ca_count: 56
      console_count: 56
    total_ocpu_capacity: 56
    load_balancer_shape: load_balancer_shape_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update blockchain_platform using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_blockchain_platform:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    description: description_example
    storage_size_in_tbs: 3.4
    replicas:
      # optional
      proxy_count: 56
      ca_count: 56
      console_count: 56
    total_ocpu_capacity: 56
    load_balancer_shape: load_balancer_shape_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete blockchain_platform
  oci_blockchain_platform:
    # required
    blockchain_platform_id: "ocid1.blockchainplatform.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete blockchain_platform using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_blockchain_platform:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
blockchain_platform
complex
on success
Details of the BlockchainPlatform resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'component_details': {'osns': [{'ad': 'Uocm:PHX-AD-1', 'lifecycle_state': 'ACTIVE', 'ocpu_allocation_param': {'ocpu_allocation_number': 3.4}, 'osn_key': 'osn_key_example'}], 'peers': [{'ad': 'Uocm:PHX-AD-1', 'alias': 'alias_example', 'host': 'host_example', 'lifecycle_state': 'ACTIVE', 'ocpu_allocation_param': {'ocpu_allocation_number': 3.4}, 'peer_key': 'peer_key_example', 'role': 'role_example'}]}, 'compute_shape': 'STANDARD', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'description': 'description_example', 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'host_ocpu_utilization_info': [{'host': 'host_example', 'ocpu_capacity_number': 3.4, 'ocpu_utilization_number': 3.4}], 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_byol': True, 'is_multi_ad': True, 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'CREATING', 'load_balancer_shape': 'LB_100_MBPS', 'platform_role': 'FOUNDER', 'platform_shape_type': 'DEFAULT', 'platform_version': 'platform_version_example', 'replicas': {'ca_count': 56, 'console_count': 56, 'proxy_count': 56}, 'service_endpoint': 'service_endpoint_example', 'service_version': 'service_version_example', 'storage_size_in_tbs': 1.2, 'storage_used_in_t_bs': 1.2, 'time_created': '2013-10-20T19:20:30+01:00', 'time_updated': '2013-10-20T19:20:30+01:00', 'total_ocpu_capacity': 56}
 
compartment_id
string
on success
Compartment Identifier

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
component_details
complex
on success

   
osns
complex
on success
List of OSNs

     
ad
string
on success
Availability Domain of OSN

Sample:
Uocm:PHX-AD-1
     
lifecycle_state
string
on success
The current state of the OSN.

Sample:
ACTIVE
     
ocpu_allocation_param
complex
on success

       
ocpu_allocation_number
float
on success
Number of OCPU allocation

Sample:
3.4
     
osn_key
string
on success
OSN identifier

Sample:
osn_key_example
   
peers
complex
on success
List of Peers

     
ad
string
on success
Availability Domain of peer

Sample:
Uocm:PHX-AD-1
     
alias
string
on success
peer alias

Sample:
alias_example
     
host
string
on success
Host on which the Peer exists

Sample:
host_example
     
lifecycle_state
string
on success
The current state of the peer.

Sample:
ACTIVE
     
ocpu_allocation_param
complex
on success

       
ocpu_allocation_number
float
on success
Number of OCPU allocation

Sample:
3.4
     
peer_key
string
on success
peer identifier

Sample:
peer_key_example
     
role
string
on success
Peer role

Sample:
role_example
 
compute_shape
string
on success
Compute shape - STANDARD or ENTERPRISE_SMALL or ENTERPRISE_MEDIUM or ENTERPRISE_LARGE or ENTERPRISE_EXTRA_LARGE or ENTERPRISE_CUSTOM

Sample:
STANDARD
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
description
string
on success
Platform Instance Description

Sample:
description_example
 
display_name
string
on success
Platform Instance Display name, can be renamed

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}`

Sample:
{'Department': 'Finance'}
 
host_ocpu_utilization_info
complex
on success
List of OcpuUtilization for all hosts

   
host
string
on success
Host name of VM

Sample:
host_example
   
ocpu_capacity_number
float
on success
Number of total OCPU capacity on the host

Sample:
3.4
   
ocpu_utilization_number
float
on success
Number of OCPU utilized

Sample:
3.4
 
id
string
on success
unique identifier that is immutable on creation

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_byol
boolean
on success
Bring your own license

Sample:
True
 
is_multi_ad
boolean
on success
True for multi-AD blockchain plaforms, false for single-AD

Sample:
True
 
lifecycle_details
string
on success
An message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current state of the Platform Instance.

Sample:
CREATING
 
load_balancer_shape
string
on success
Type of Load Balancer shape - LB_100_MBPS or LB_400_MBPS. Default is LB_100_MBPS.

Sample:
LB_100_MBPS
 
platform_role
string
on success
Role of platform - FOUNDER or PARTICIPANT

Sample:
FOUNDER
 
platform_shape_type
string
on success
Type of Platform shape - DEFAULT or CUSTOM

Sample:
DEFAULT
 
platform_version
string
on success
Platform Version

Sample:
platform_version_example
 
replicas
complex
on success

   
ca_count
integer
on success
Number of CA replicas

Sample:
56
   
console_count
integer
on success
Number of console replicas

Sample:
56
   
proxy_count
integer
on success
Number of REST proxy replicas

Sample:
56
 
service_endpoint
string
on success
Service endpoint URL, valid post-provisioning

Sample:
service_endpoint_example
 
service_version
string
on success
The version of the Platform Instance.

Sample:
service_version_example
 
storage_size_in_tbs
float
on success
Storage size in TBs

Sample:
1.2
 
storage_used_in_t_bs
float
on success
Storage used in TBs

Sample:
1.2
 
time_created
string
on success
The time the the Platform Instance was created. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
time_updated
string
on success
The time the Platform Instance was updated. An RFC3339 formatted datetime string

Sample:
2013-10-20T19:20:30+01:00
 
total_ocpu_capacity
integer
on success
Number of total OCPUs allocated to the platform cluster

Sample:
56


Authors

  • Oracle (@oracle)