oracle.oci.oci_osp_gateway_subscription – Manage a Subscription resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.3.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_osp_gateway_subscription
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to update a Subscription resource in Oracle Cloud Infrastructure
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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. |
|||
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
/ required
|
The OCID of the compartment.
|
||||
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 . |
||||
email
string
/ required
|
User email
|
||||
osp_home_region
string
/ required
|
The home region's public name of the logged in user.
|
||||
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
|||
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. |
||||
state
string
|
|
The state of the Subscription.
Use state=present to update an existing a Subscription.
|
|||
subscription
dictionary
/ required
|
|||||
account_type
string
|
|
Account type.
This parameter is updatable.
|
|||
bill_to_cust_account_id
string
|
Bill to customer Account id.
This parameter is updatable.
|
||||
billing_address
dictionary
|
|||||
address_key
string
|
Address identifier.
This parameter is updatable.
|
||||
city
string
|
Name of the city.
This parameter is updatable.
|
||||
company_name
string
|
Name of the customer company.
This parameter is updatable.
|
||||
contributor_class
string
|
Contributor class of the customer company.
This parameter is updatable.
|
||||
country
string
|
Country of the address.
This parameter is updatable.
|
||||
county
string
|
County of the address.
This parameter is updatable.
|
||||
department_name
string
|
Department name of the customer company.
This parameter is updatable.
|
||||
email_address
string
|
Contact person email address.
This parameter is updatable.
|
||||
first_name
string
|
First name of the contact person.
This parameter is updatable.
|
||||
internal_number
string
|
Internal number of the customer company.
This parameter is updatable.
|
||||
job_title
string
|
Job title of the contact person.
This parameter is updatable.
|
||||
last_name
string
|
Last name of the contact person.
This parameter is updatable.
|
||||
line1
string
|
Address line 1.
This parameter is updatable.
|
||||
line2
string
|
Address line 2.
This parameter is updatable.
|
||||
line3
string
|
Address line 3.
This parameter is updatable.
|
||||
line4
string
|
Address line 4.
This parameter is updatable.
|
||||
middle_name
string
|
Middle name of the contact person.
This parameter is updatable.
|
||||
municipal_inscription
string
|
Municipal Inscription.
This parameter is updatable.
|
||||
phone_country_code
string
|
Phone country code of the contact person.
This parameter is updatable.
|
||||
phone_number
string
|
Phone number of the contact person.
This parameter is updatable.
|
||||
postal_code
string
|
Post code of the address.
This parameter is updatable.
|
||||
province
string
|
Province of the address.
This parameter is updatable.
|
||||
state
string
|
State of the address.
This parameter is updatable.
|
||||
state_inscription
string
|
State Inscription.
This parameter is updatable.
|
||||
street_name
string
|
Street name of the address.
This parameter is updatable.
|
||||
street_number
string
|
Street number of the address.
This parameter is updatable.
|
||||
currency_code
string
|
Currency code
This parameter is updatable.
|
||||
gsi_org_code
string
|
GSI Subscription external code.
This parameter is updatable.
|
||||
id
string
|
Subscription id identifier (OCID).
This parameter is updatable.
|
||||
is_intent_to_pay
boolean
|
|
Payment intension.
This parameter is updatable.
|
|||
language_code
string
|
Language short code (en, de, hu, etc)
This parameter is updatable.
|
||||
organization_id
string
|
GSI organization external identifier.
This parameter is updatable.
|
||||
payment_gateway
dictionary
|
|||||
merchant_defined_data
dictionary
|
|||||
cloud_account_name
string
|
Cloud account name.
This parameter is updatable.
|
||||
promo_type
string
|
Promotion type code.
This parameter is updatable.
|
||||
payment_options
list
/ elements=dictionary
|
Payment option list of a subscription.
|
||||
credit_card_type
string
|
|
Credit card type.
This parameter is updatable.
Applicable when payment_method is 'CREDIT_CARD'
|
|||
email_address
string
|
The email address of the paypal user.
This parameter is updatable.
Applicable when payment_method is 'PAYPAL'
|
||||
ext_billing_agreement_id
string
|
Agreement id for the paypal account.
This parameter is updatable.
Applicable when payment_method is 'PAYPAL'
|
||||
first_name
string
|
First name of the paypal user.
This parameter is updatable.
Applicable when payment_method is 'PAYPAL'
|
||||
last_digits
string
|
Last four digits of the card.
This parameter is updatable.
Applicable when payment_method is 'CREDIT_CARD'
|
||||
last_name
string
|
Last name of the paypal user.
This parameter is updatable.
Applicable when payment_method is 'PAYPAL'
|
||||
name_on_card
string
|
Name on the credit card.
This parameter is updatable.
Applicable when payment_method is 'CREDIT_CARD'
|
||||
payment_method
string
/ required
|
|
Payment method
This parameter is updatable.
|
|||
time_expiration
string
|
Expired date of the credit card.
This parameter is updatable.
Applicable when payment_method is 'CREDIT_CARD'
|
||||
wallet_instrument_id
string
|
Wallet instrument internal id.
This parameter is updatable.
|
||||
wallet_transaction_id
string
|
Wallet transaction id.
This parameter is updatable.
|
||||
plan_type
string
|
|
Subscription plan type.
This parameter is updatable.
|
|||
ship_to_cust_acct_role_id
string
|
Ship to customer account role.
This parameter is updatable.
|
||||
ship_to_cust_acct_site_id
string
|
Ship to customer account site address id.
This parameter is updatable.
|
||||
subscription_plan_number
string
/ required
|
Subscription plan number.
This parameter is updatable.
|
||||
tax_info
dictionary
|
|||||
no_tax_reason_code
string
|
Tax exemption reason code.
This parameter is updatable.
|
||||
no_tax_reason_code_details
string
|
Tax exemption reason description.
This parameter is updatable.
|
||||
tax_cnpj
string
|
Brazilian companies' CNPJ number.
This parameter is updatable.
|
||||
tax_payer_id
string
|
Tay payer identifier.
This parameter is updatable.
|
||||
tax_reg_number
string
|
Tax registration number.
This parameter is updatable.
|
||||
time_personal_to_corporate_conv
string
|
Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
This parameter is updatable.
|
||||
time_plan_upgrade
string
|
Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
This parameter is updatable.
|
||||
time_start
string
|
Start date of the subscription.
This parameter is updatable.
|
||||
upgrade_state
string
|
|
Status of the upgrade.
This parameter is updatable.
|
|||
upgrade_state_details
string
|
|
This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
This parameter is updatable.
|
|||
subscription_id
string
/ required
|
Subscription id(OCID).
aliases: id |
||||
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Update subscription
oci_osp_gateway_subscription:
# required
subscription_id: "ocid1.subscription.oc1..xxxxxxEXAMPLExxxxxx"
osp_home_region: us-phoenix-1
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
subscription:
# required
subscription_plan_number: subscription_plan_number_example
# optional
id: "ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx"
plan_type: FREE_TIER
time_start: time_start_example
ship_to_cust_acct_site_id: "ocid1.shiptocustacctsite.oc1..xxxxxxEXAMPLExxxxxx"
ship_to_cust_acct_role_id: "ocid1.shiptocustacctrole.oc1..xxxxxxEXAMPLExxxxxx"
bill_to_cust_account_id: "ocid1.billtocustaccount.oc1..xxxxxxEXAMPLExxxxxx"
is_intent_to_pay: true
currency_code: currency_code_example
gsi_org_code: gsi_org_code_example
language_code: language_code_example
organization_id: "ocid1.organization.oc1..xxxxxxEXAMPLExxxxxx"
upgrade_state: PROMO
upgrade_state_details: TAX_ERROR
account_type: PERSONAL
tax_info:
# optional
tax_payer_id: "ocid1.taxpayer.oc1..xxxxxxEXAMPLExxxxxx"
tax_reg_number: tax_reg_number_example
no_tax_reason_code: no_tax_reason_code_example
no_tax_reason_code_details: no_tax_reason_code_details_example
tax_cnpj: tax_cnpj_example
payment_options:
- # required
payment_method: CREDIT_CARD
# optional
credit_card_type: VISA
last_digits: last_digits_example
name_on_card: name_on_card_example
time_expiration: time_expiration_example
wallet_instrument_id: "ocid1.walletinstrument.oc1..xxxxxxEXAMPLExxxxxx"
wallet_transaction_id: "ocid1.wallettransaction.oc1..xxxxxxEXAMPLExxxxxx"
payment_gateway:
# optional
merchant_defined_data:
# optional
promo_type: promo_type_example
cloud_account_name: cloud_account_name_example
billing_address:
# optional
address_key: address_key_example
line1: line1_example
line2: line2_example
line3: line3_example
line4: line4_example
street_name: street_name_example
street_number: street_number_example
city: city_example
county: county_example
country: country_example
province: province_example
postal_code: postal_code_example
state: state_example
email_address: email_address_example
company_name: company_name_example
first_name: first_name_example
middle_name: middle_name_example
last_name: last_name_example
phone_country_code: phone_country_code_example
phone_number: phone_number_example
job_title: job_title_example
department_name: department_name_example
internal_number: internal_number_example
contributor_class: contributor_class_example
state_inscription: state_inscription_example
municipal_inscription: municipal_inscription_example
time_plan_upgrade: time_plan_upgrade_example
time_personal_to_corporate_conv: time_personal_to_corporate_conv_example
email: email_example
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)