diff --git a/docs/ibm_api_gateway_endpoint.rst b/docs/ibm_api_gateway_endpoint.rst index 81aa8337f..02bd69acb 100644 --- a/docs/ibm_api_gateway_endpoint.rst +++ b/docs/ibm_api_gateway_endpoint.rst @@ -31,12 +31,8 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - open_api_doc_name (True, str, None) - (Required for new resource) Json File path - - - routes (False, list, None) - Invokable routes for an endpoint + service_instance_crn (True, str, None) + (Required for new resource) Api Gateway Service Instance Crn managed (False, bool, False) @@ -47,16 +43,20 @@ Parameters Action type of Endpoint ALoowable values are share, unshare, manage, unmanage - service_instance_crn (True, str, None) - (Required for new resource) Api Gateway Service Instance Crn + provider_id (False, str, user-defined) + Provider ID of an endpoint allowable values user-defined and whisk + + + open_api_doc_name (True, str, None) + (Required for new resource) Json File path name (True, str, None) (Required for new resource) Endpoint name - provider_id (False, str, user-defined) - Provider ID of an endpoint allowable values user-defined and whisk + routes (False, list, None) + Invokable routes for an endpoint id (False, str, None) diff --git a/docs/ibm_app_config_environment.rst b/docs/ibm_app_config_environment.rst index 52744896b..7a565f0ae 100644 --- a/docs/ibm_app_config_environment.rst +++ b/docs/ibm_app_config_environment.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + environment_id (True, str, None) + (Required for new resource) Environment Id. + + color_code (False, str, None) Color code to distinguish the environment. @@ -39,10 +43,6 @@ Parameters (Required for new resource) Environment name. - environment_id (True, str, None) - (Required for new resource) Environment Id. - - description (False, str, None) Environment description diff --git a/docs/ibm_app_config_environment_info.rst b/docs/ibm_app_config_environment_info.rst index f314cd6ae..28a9fabfa 100644 --- a/docs/ibm_app_config_environment_info.rst +++ b/docs/ibm_app_config_environment_info.rst @@ -33,14 +33,14 @@ Parameters GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. - expand (False, bool, None) - If set to `true`, returns expanded view of the resource details. - - environment_id (True, str, None) Environment Id. + expand (False, bool, None) + If set to `true`, returns expanded view of the resource details. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_app_config_environments_info.rst b/docs/ibm_app_config_environments_info.rst index 237526961..3fddb9578 100644 --- a/docs/ibm_app_config_environments_info.rst +++ b/docs/ibm_app_config_environments_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + tags (False, str, None) + filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags. + + limit (False, int, None) The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records. @@ -41,10 +45,6 @@ Parameters If set to `true`, returns expanded view of the resource details. - tags (False, str, None) - filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags. - - offset (False, int, None) The number of records to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset` value. Use `offset` with `limit` to page through the available records. diff --git a/docs/ibm_app_config_feature.rst b/docs/ibm_app_config_feature.rst index 7e410a84b..3e1627c99 100644 --- a/docs/ibm_app_config_feature.rst +++ b/docs/ibm_app_config_feature.rst @@ -31,50 +31,50 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - segment_rules (False, list, None) - Specify the targeting rules that is used to set different feature flag values for different segments. + guid (True, str, None) + (Required for new resource) GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. - collections (False, list, None) - List of collection id representing the collections that are associated with the specified feature flag. + environment_id (True, str, None) + (Required for new resource) Environment Id. - type (True, str, None) - (Required for new resource) Type of the feature (BOOLEAN, STRING, NUMERIC). + tags (False, str, None) + Tags associated with the feature. - enabled_value (True, str, None) - (Required for new resource) Value of the feature when it is enabled. The value can be BOOLEAN, STRING or a NUMERIC value as per the `type` attribute. + feature_id (True, str, None) + (Required for new resource) Feature id. + + + type (True, str, None) + (Required for new resource) Type of the feature (BOOLEAN, STRING, NUMERIC). description (False, str, None) Feature description. - tags (False, str, None) - Tags associated with the feature. + name (True, str, None) + (Required for new resource) Feature name. - environment_id (True, str, None) - (Required for new resource) Environment Id. + enabled_value (True, str, None) + (Required for new resource) Value of the feature when it is enabled. The value can be BOOLEAN, STRING or a NUMERIC value as per the `type` attribute. - name (True, str, None) - (Required for new resource) Feature name. + segment_rules (False, list, None) + Specify the targeting rules that is used to set different feature flag values for different segments. - feature_id (True, str, None) - (Required for new resource) Feature id. + collections (False, list, None) + List of collection id representing the collections that are associated with the specified feature flag. disabled_value (True, str, None) (Required for new resource) Value of the feature when it is disabled. The value can be BOOLEAN, STRING or a NUMERIC value as per the `type` attribute. - guid (True, str, None) - (Required for new resource) GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_app_config_feature_info.rst b/docs/ibm_app_config_feature_info.rst index eb3e8ae7f..6d77a449b 100644 --- a/docs/ibm_app_config_feature_info.rst +++ b/docs/ibm_app_config_feature_info.rst @@ -29,10 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - environment_id (True, str, None) - Environment Id. - - guid (True, str, None) GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. @@ -45,6 +41,10 @@ Parameters Include the associated collections in the response. + environment_id (True, str, None) + Environment Id. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_app_config_features_info.rst b/docs/ibm_app_config_features_info.rst index 3803fc312..b7c6c3574 100644 --- a/docs/ibm_app_config_features_info.rst +++ b/docs/ibm_app_config_features_info.rst @@ -29,10 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - guid (True, str, None) - GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. - - collections (False, list, None) Filter features by a list of comma separated collections. @@ -41,32 +37,36 @@ Parameters If set to `true`, returns expanded view of the resource details. - limit (False, int, None) - The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records. - - offset (False, int, None) The number of records to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset` value. Use `offset` with `limit` to page through the available records. - tags (False, str, None) - Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags. + guid (True, str, None) + GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. environment_id (True, str, None) Environment Id. - sort (False, str, None) - Sort the feature details based on the specified attribute. + segments (False, list, None) + Filter features by a list of comma separated segments. includes (False, list, None) Include the associated collections or targeting rules details in the response. - segments (False, list, None) - Filter features by a list of comma separated segments. + limit (False, int, None) + The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records. + + + sort (False, str, None) + Sort the feature details based on the specified attribute. + + + tags (False, str, None) + Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags. iaas_classic_username (False, any, None) diff --git a/docs/ibm_app_route.rst b/docs/ibm_app_route.rst index a6db24145..89e563072 100644 --- a/docs/ibm_app_route.rst +++ b/docs/ibm_app_route.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - port (False, int, None) - The port of the route. Supported for domains of TCP router groups only. - - path (False, str, None) The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?' @@ -55,6 +51,10 @@ Parameters (Required for new resource) The guid of the associated domain + port (False, int, None) + The port of the route. Supported for domains of TCP router groups only. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_appid_apm.rst b/docs/ibm_appid_apm.rst index ab75e8fb8..a05556ca5 100644 --- a/docs/ibm_appid_apm.rst +++ b/docs/ibm_appid_apm.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + password_expiration (True, list, None) + (Required for new resource) + + lockout_policy (True, list, None) (Required for new resource) @@ -55,10 +59,6 @@ Parameters (Required for new resource) - password_expiration (True, list, None) - (Required for new resource) - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_appid_application_info.rst b/docs/ibm_appid_application_info.rst index d518634e9..5df7a0bb2 100644 --- a/docs/ibm_appid_application_info.rst +++ b/docs/ibm_appid_application_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - tenant_id (True, str, None) - The service `tenantId` - - client_id (True, str, None) The `client_id` is a public identifier for applications + tenant_id (True, str, None) + The service `tenantId` + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_appid_application_scopes.rst b/docs/ibm_appid_application_scopes.rst index 31b9c9b00..efff88d56 100644 --- a/docs/ibm_appid_application_scopes.rst +++ b/docs/ibm_appid_application_scopes.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - tenant_id (True, str, None) - (Required for new resource) The service `tenantId` - - client_id (True, str, None) (Required for new resource) The `client_id` is a public identifier for applications @@ -43,6 +39,10 @@ Parameters (Required for new resource) A `scope` is a runtime action in your application that you register with IBM Cloud App ID to create an access permission + tenant_id (True, str, None) + (Required for new resource) The service `tenantId` + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_appid_cloud_directory_template.rst b/docs/ibm_appid_cloud_directory_template.rst index 4f95da267..d693b2733 100644 --- a/docs/ibm_appid_cloud_directory_template.rst +++ b/docs/ibm_appid_cloud_directory_template.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - template_name (True, str, None) - (Required for new resource) The type of email template. This can be `USER_VERIFICATION`, `WELCOME`, `PASSWORD_CHANGED`, `RESET_PASSWORD` or `MFA_VERIFICATION` - - language (False, str, en) Preferred language for resource. Format as described at RFC5646. According to the configured languages codes returned from the `GET /management/v4/{tenantId}/config/ui/languages API`. @@ -55,6 +51,10 @@ Parameters (Required for new resource) The AppID instance GUID + template_name (True, str, None) + (Required for new resource) The type of email template. This can be `USER_VERIFICATION`, `WELCOME`, `PASSWORD_CHANGED`, `RESET_PASSWORD` or `MFA_VERIFICATION` + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_appid_cloud_directory_user.rst b/docs/ibm_appid_cloud_directory_user.rst index 812ad0b59..09d0ebb49 100644 --- a/docs/ibm_appid_cloud_directory_user.rst +++ b/docs/ibm_appid_cloud_directory_user.rst @@ -31,40 +31,40 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - active (False, bool, True) - Determines if the user account is active or not - - - locked_until (False, int, None) - Integer (epoch time in milliseconds), determines till when the user account will be locked - - - status (False, str, PENDING) - Accepted values `PENDING` or `CONFIRMED` + display_name (False, str, None) + Cloud Directory user display name - email (True, list, None) - (Required for new resource) A set of user emails + user_name (False, str, None) + Optional username password (True, str, None) (Required for new resource) User password - tenant_id (True, str, None) - (Required for new resource) The AppID instance GUID + status (False, str, PENDING) + Accepted values `PENDING` or `CONFIRMED` create_profile (False, bool, True) A boolean indication if a profile should be created for the Cloud Directory user - display_name (False, str, None) - Cloud Directory user display name + locked_until (False, int, None) + Integer (epoch time in milliseconds), determines till when the user account will be locked - user_name (False, str, None) - Optional username + email (True, list, None) + (Required for new resource) A set of user emails + + + tenant_id (True, str, None) + (Required for new resource) The AppID instance GUID + + + active (False, bool, True) + Determines if the user account is active or not id (False, str, None) diff --git a/docs/ibm_appid_cloud_directory_user_info.rst b/docs/ibm_appid_cloud_directory_user_info.rst index 6c833ca24..c66c9e76e 100644 --- a/docs/ibm_appid_cloud_directory_user_info.rst +++ b/docs/ibm_appid_cloud_directory_user_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - user_id (True, str, None) - Cloud Directory user ID - - tenant_id (True, str, None) The AppID instance GUID + user_id (True, str, None) + Cloud Directory user ID + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_appid_idp_cloud_directory.rst b/docs/ibm_appid_idp_cloud_directory.rst index 1a9ac2144..722cef3ca 100644 --- a/docs/ibm_appid_idp_cloud_directory.rst +++ b/docs/ibm_appid_idp_cloud_directory.rst @@ -31,15 +31,19 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - signup_enabled (False, bool, True) + welcome_enabled (False, bool, True) None - welcome_enabled (False, bool, True) + reset_password_enabled (False, bool, True) None - reset_password_enabled (False, bool, True) + identity_confirm_methods (False, list, None) + None + + + signup_enabled (False, bool, True) None @@ -51,7 +55,7 @@ Parameters None - identity_confirm_methods (False, list, None) + identity_field (False, str, None) None @@ -67,10 +71,6 @@ Parameters None - identity_field (False, str, None) - None - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_appid_idp_custom.rst b/docs/ibm_appid_idp_custom.rst index 39666c473..2a7701ae5 100644 --- a/docs/ibm_appid_idp_custom.rst +++ b/docs/ibm_appid_idp_custom.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + public_key (False, str, None) + This is the public key used to validate your signed JWT. It is required to be a PEM in the RS256 or greater format. + + tenant_id (True, str, None) (Required for new resource) The service `tenantId` @@ -39,10 +43,6 @@ Parameters (Required for new resource) - public_key (False, str, None) - This is the public key used to validate your signed JWT. It is required to be a PEM in the RS256 or greater format. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_appid_idp_google.rst b/docs/ibm_appid_idp_google.rst index 2059f58ee..31b1bacdb 100644 --- a/docs/ibm_appid_idp_google.rst +++ b/docs/ibm_appid_idp_google.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - config (False, list, None) - Google IDP configuration - - tenant_id (True, str, None) (Required for new resource) The AppID instance GUID @@ -43,6 +39,10 @@ Parameters (Required for new resource) `true` if Google IDP configuration is active + config (False, list, None) + Google IDP configuration + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_appid_token_config.rst b/docs/ibm_appid_token_config.rst index d7c31212e..0cce5b1a1 100644 --- a/docs/ibm_appid_token_config.rst +++ b/docs/ibm_appid_token_config.rst @@ -31,6 +31,18 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + anonymous_token_expires_in (False, int, 2592000) + None + + + anonymous_access_enabled (False, bool, None) + The length of time for which an anonymous token is valid in seconds + + + refresh_token_enabled (False, bool, None) + None + + access_token_claim (False, list, None) A set of objects that are created when claims that are related to access tokens are mapped @@ -51,18 +63,6 @@ Parameters The length of time for which refresh tokens are valid in seconds - anonymous_token_expires_in (False, int, 2592000) - None - - - anonymous_access_enabled (False, bool, None) - The length of time for which an anonymous token is valid in seconds - - - refresh_token_enabled (False, bool, None) - None - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_appid_user_roles.rst b/docs/ibm_appid_user_roles.rst index 00faaa159..85174e7f3 100644 --- a/docs/ibm_appid_user_roles.rst +++ b/docs/ibm_appid_user_roles.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + role_ids (True, list, None) + (Required for new resource) A set of AppID role IDs that should be assigned to the user + + tenant_id (True, str, None) (Required for new resource) The AppID instance GUID @@ -39,10 +43,6 @@ Parameters (Required for new resource) The user's identifier ('subject' in identity token) - role_ids (True, list, None) - (Required for new resource) A set of AppID role IDs that should be assigned to the user - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cbr_rule.rst b/docs/ibm_cbr_rule.rst index dea45f68b..51d2e85e8 100644 --- a/docs/ibm_cbr_rule.rst +++ b/docs/ibm_cbr_rule.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - description (False, str, None) - The description of the rule. - - contexts (True, list, None) (Required for new resource) The contexts this rule applies to. @@ -43,6 +39,10 @@ Parameters (Required for new resource) The resources this rule apply to. + description (False, str, None) + The description of the rule. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cbr_zone.rst b/docs/ibm_cbr_zone.rst index 4d5762443..f52fd6390 100644 --- a/docs/ibm_cbr_zone.rst +++ b/docs/ibm_cbr_zone.rst @@ -39,14 +39,14 @@ Parameters (Required for new resource) The list of addresses in the zone. - excluded (False, list, None) - The list of excluded addresses in the zone. Only addresses of type `ipAddress`, `ipRange`, and `subnet` can be excluded. - - name (True, str, None) (Required for new resource) The name of the zone. + excluded (False, list, None) + The list of excluded addresses in the zone. Only addresses of type `ipAddress`, `ipRange`, and `subnet` can be excluded. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cdn.rst b/docs/ibm_cdn.rst index 4ebc69106..1fc193582 100644 --- a/docs/ibm_cdn.rst +++ b/docs/ibm_cdn.rst @@ -31,24 +31,12 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - bucket_name (False, str, None) - Bucket name - - - http_port (False, int, 80) - HTTP port number - - - respect_headers (False, bool, True) - respect headers info - - - host_name (True, str, None) - (Required for new resource) Host name + origin_type (False, str, HOST_SERVER) + Origin type info - cname (False, str, None) - cname info + https_port (False, int, 443) + HTTPS port number file_extension (False, str, None) @@ -59,10 +47,18 @@ Parameters query rule info + performance_configuration (False, str, General web delivery) + performance configuration info + + path (False, str, /*) Path details + vendor_name (False, str, akamai) + Vendor name + + origin_address (True, str, None) (Required for new resource) origin address info @@ -71,30 +67,34 @@ Parameters Protocol name - performance_configuration (False, str, General web delivery) - performance configuration info + cname (False, str, None) + cname info - vendor_name (False, str, akamai) - Vendor name + host_name (True, str, None) + (Required for new resource) Host name - origin_type (False, str, HOST_SERVER) - Origin type info + bucket_name (False, str, None) + Bucket name - https_port (False, int, 443) - HTTPS port number + http_port (False, int, 80) + HTTP port number - header (False, str, None) - Header info + respect_headers (False, bool, True) + respect headers info certificate_type (False, str, None) Certificate type + header (False, str, None) + Header info + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_certificate_manager_certificate_info.rst b/docs/ibm_certificate_manager_certificate_info.rst index f1f3781df..abbda6e3a 100644 --- a/docs/ibm_certificate_manager_certificate_info.rst +++ b/docs/ibm_certificate_manager_certificate_info.rst @@ -29,11 +29,11 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) + certificate_manager_instance_id (True, str, None) None - certificate_manager_instance_id (True, str, None) + name (True, str, None) None diff --git a/docs/ibm_certificate_manager_import.rst b/docs/ibm_certificate_manager_import.rst index 27992d42c..6f2bc1867 100644 --- a/docs/ibm_certificate_manager_import.rst +++ b/docs/ibm_certificate_manager_import.rst @@ -35,14 +35,14 @@ Parameters (Required for new resource) Instance ID of the certificate manager resource - data (True, dict, None) - (Required for new resource) certificate data - - name (True, str, None) (Required for new resource) Name of the instance + data (True, dict, None) + (Required for new resource) certificate data + + description (False, str, None) Description of the certificate instance diff --git a/docs/ibm_certificate_manager_order.rst b/docs/ibm_certificate_manager_order.rst index 3aa30a14c..9cc37ccba 100644 --- a/docs/ibm_certificate_manager_order.rst +++ b/docs/ibm_certificate_manager_order.rst @@ -31,46 +31,46 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - key_algorithm (False, str, rsaEncryption 2048 bit) - Keyalgorithm info - - auto_renew_enabled (False, bool, False) None - name (True, str, None) - (Required for new resource) Certificate name - - domains (True, list, None) (Required for new resource) List of domain names - dns_provider_instance_crn (False, str, None) - DNS provider instance CRN + domain_validation_method (False, str, dns-01) + Domain validation methods certificate_manager_instance_id (True, str, None) (Required for new resource) Certificate manager instance ID - description (False, str, None) - Certicate description - - renew_certificate (False, bool, False) Invokes renew functionality - domain_validation_method (False, str, dns-01) - Domain validation methods + key_algorithm (False, str, rsaEncryption 2048 bit) + Keyalgorithm info + + + name (True, str, None) + (Required for new resource) Certificate name rotate_keys (False, bool, False) Keys are sorated if set to true + description (False, str, None) + Certicate description + + + dns_provider_instance_crn (False, str, None) + DNS provider instance CRN + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis.rst b/docs/ibm_cis.rst index 1724dbb9f..03988f653 100644 --- a/docs/ibm_cis.rst +++ b/docs/ibm_cis.rst @@ -31,28 +31,28 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - parameters (False, dict, None) - Arbitrary parameters to pass. Must be a JSON object - - - name (True, str, None) - (Required for new resource) A name for the resource instance + tags (False, list, None) + None plan (True, str, None) (Required for new resource) The plan type of the service + name (True, str, None) + (Required for new resource) A name for the resource instance + + location (True, str, None) (Required for new resource) The location where the instance available - resource_group_id (False, str, None) - The resource group id + parameters (False, dict, None) + Arbitrary parameters to pass. Must be a JSON object - tags (False, list, None) - None + resource_group_id (False, str, None) + The resource group id id (False, str, None) diff --git a/docs/ibm_cis_cache_settings.rst b/docs/ibm_cis_cache_settings.rst index 19e136ae2..883d684d4 100644 --- a/docs/ibm_cis_cache_settings.rst +++ b/docs/ibm_cis_cache_settings.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + cis_id (True, str, None) + (Required for new resource) CIS instance crn + + domain_id (True, str, None) (Required for new resource) Associated CIS domain @@ -39,42 +43,38 @@ Parameters Cache level setting - serve_stale_content (False, str, True) - Serve Stale Content - - browser_expiration (False, int, None) Browser Expiration setting - development_mode (False, str, None) - Development mode setting + purge_by_urls (False, list, None) + Purge by URLs - query_string_sort (False, str, None) - Query String sort setting + serve_stale_content (False, str, True) + Serve Stale Content - purge_by_hosts (False, list, None) - Purge by hosts + development_mode (False, str, None) + Development mode setting - cis_id (True, str, None) - (Required for new resource) CIS instance crn + query_string_sort (False, str, None) + Query String sort setting purge_all (False, bool, None) Purge all setting - purge_by_urls (False, list, None) - Purge by URLs - - purge_by_tags (False, list, None) Purge by tags + purge_by_hosts (False, list, None) + Purge by hosts + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis_cache_settings_info.rst b/docs/ibm_cis_cache_settings_info.rst index 3e5fcb37a..121e2e275 100644 --- a/docs/ibm_cis_cache_settings_info.rst +++ b/docs/ibm_cis_cache_settings_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - cis_id (True, str, None) - CIS instance crn - - domain_id (True, str, None) Associated CIS domain + cis_id (True, str, None) + CIS instance crn + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_cis_certificate_order.rst b/docs/ibm_cis_certificate_order.rst index 01f28aed0..b3ca2708d 100644 --- a/docs/ibm_cis_certificate_order.rst +++ b/docs/ibm_cis_certificate_order.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - hosts (True, list, None) - (Required for new resource) Hosts which certificate need to be ordered - - cis_id (True, str, None) (Required for new resource) CIS object id or CRN @@ -47,6 +43,10 @@ Parameters certificate type + hosts (True, list, None) + (Required for new resource) Hosts which certificate need to be ordered + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis_certificate_upload.rst b/docs/ibm_cis_certificate_upload.rst index 68fe6cdcd..81c7c6056 100644 --- a/docs/ibm_cis_certificate_upload.rst +++ b/docs/ibm_cis_certificate_upload.rst @@ -31,28 +31,28 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - bundle_method (False, str, ubiquitous) - Certificate bundle method + certificate (True, str, None) + (Required for new resource) Certificate key private_key (True, str, None) (Required for new resource) Certificate private key - priority (False, int, None) - Certificate priority + bundle_method (False, str, ubiquitous) + Certificate bundle method - cis_id (True, str, None) - (Required for new resource) CIS instance crn + priority (False, int, None) + Certificate priority domain_id (True, str, None) (Required for new resource) Associated CIS domain - certificate (True, str, None) - (Required for new resource) Certificate key + cis_id (True, str, None) + (Required for new resource) CIS instance crn id (False, str, None) diff --git a/docs/ibm_cis_custom_page.rst b/docs/ibm_cis_custom_page.rst index 098563eec..61e73cc2f 100644 --- a/docs/ibm_cis_custom_page.rst +++ b/docs/ibm_cis_custom_page.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - page_id (True, str, None) - (Required for new resource) Custom page identifier - - - url (True, str, None) - (Required for new resource) Custom page url - - cis_id (True, str, None) (Required for new resource) CIS instance crn @@ -47,6 +39,14 @@ Parameters (Required for new resource) Associated CIS domain + page_id (True, str, None) + (Required for new resource) Custom page identifier + + + url (True, str, None) + (Required for new resource) Custom page url + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis_dns_record.rst b/docs/ibm_cis_dns_record.rst index 6a44ab0c4..fd6221ac3 100644 --- a/docs/ibm_cis_dns_record.rst +++ b/docs/ibm_cis_dns_record.rst @@ -35,20 +35,20 @@ Parameters (Required for new resource) CIS object id or CRN - data (False, dict, None) - None - - priority (False, int, None) Priority Value + proxied (False, bool, False) + Boolean value true if proxied else flase + + name (False, str, None) DNS record name - ttl (False, int, 1) - TTL value + content (False, str, None) + DNS record content domain_id (True, str, None) @@ -59,12 +59,12 @@ Parameters (Required for new resource) Record type - content (False, str, None) - DNS record content + data (False, dict, None) + None - proxied (False, bool, False) - Boolean value true if proxied else flase + ttl (False, int, 1) + TTL value id (False, str, None) diff --git a/docs/ibm_cis_dns_records_import.rst b/docs/ibm_cis_dns_records_import.rst index 0bb6936f2..0307f7074 100644 --- a/docs/ibm_cis_dns_records_import.rst +++ b/docs/ibm_cis_dns_records_import.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + file (True, str, None) + (Required for new resource) File to import + + cis_id (True, str, None) (Required for new resource) CIS instance crn @@ -39,10 +43,6 @@ Parameters (Required for new resource) Associated CIS domain - file (True, str, None) - (Required for new resource) File to import - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis_domain_settings.rst b/docs/ibm_cis_domain_settings.rst index 78089acc8..faba016ed 100644 --- a/docs/ibm_cis_domain_settings.rst +++ b/docs/ibm_cis_domain_settings.rst @@ -31,136 +31,136 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - server_side_exclude (False, str, None) - server_side_exclude setting - - - true_client_ip_header (False, str, None) - true_client_ip_header setting + max_upload (False, int, None) + Maximum upload - dnssec (False, str, None) - DNS Sec setting + minify (False, list, None) + Minify setting - waf (False, str, None) - WAF setting + ip_geolocation (False, str, None) + ip_geolocation setting - ipv6 (False, str, None) - ipv6 setting + image_size_optimization (False, str, None) + image_size_optimization setting - image_load_optimization (False, str, None) - image_load_optimization setting + origin_error_page_pass_thru (False, str, None) + origin_error_page_pass_thru setting - max_upload (False, int, None) - Maximum upload + response_buffering (False, str, None) + response_buffering setting - mobile_redirect (False, list, None) - None + server_side_exclude (False, str, None) + server_side_exclude setting - opportunistic_encryption (False, str, None) - opportunistic_encryption setting + websockets (False, str, None) + websockets setting - brotli (False, str, None) - brotli setting + cname_flattening (False, str, None) + cname_flattening setting - websockets (False, str, None) - websockets setting + prefetch_preload (False, str, None) + prefetch_preload setting - tls_client_auth (False, str, None) - tls_client_auth setting + cipher (False, list, None) + Cipher settings - cis_id (True, str, None) - (Required for new resource) CIS instance crn + mobile_redirect (False, list, None) + None - ssl (False, str, None) - SSL/TLS setting + domain_id (True, str, None) + (Required for new resource) Associated CIS domain browser_check (False, str, None) browser_check setting - http2 (False, str, None) - http2 setting + tls_client_auth (False, str, None) + tls_client_auth setting - min_tls_version (False, str, 1.1) - Minimum version of TLS required + security_header (False, list, None) + Security Header Setting - always_use_https (False, str, None) - always_use_https setting + dnssec (False, str, None) + DNS Sec setting - script_load_optimization (False, str, None) - script_load_optimization setting + min_tls_version (False, str, 1.1) + Minimum version of TLS required - prefetch_preload (False, str, None) - prefetch_preload setting + automatic_https_rewrites (False, str, None) + automatic_https_rewrites setting - response_buffering (False, str, None) - response_buffering setting + always_use_https (False, str, None) + always_use_https setting - challenge_ttl (False, int, None) - Challenge TTL setting + ipv6 (False, str, None) + ipv6 setting - cipher (False, list, None) - Cipher settings + http2 (False, str, None) + http2 setting - cname_flattening (False, str, None) - cname_flattening setting + brotli (False, str, None) + brotli setting - hotlink_protection (False, str, None) - hotlink_protection setting + pseudo_ipv4 (False, str, None) + pseudo_ipv4 setting - ip_geolocation (False, str, None) - ip_geolocation setting + waf (False, str, None) + WAF setting - origin_error_page_pass_thru (False, str, None) - origin_error_page_pass_thru setting + ssl (False, str, None) + SSL/TLS setting - security_header (False, list, None) - Security Header Setting + true_client_ip_header (False, str, None) + true_client_ip_header setting - minify (False, list, None) - Minify setting + cis_id (True, str, None) + (Required for new resource) CIS instance crn - domain_id (True, str, None) - (Required for new resource) Associated CIS domain + hotlink_protection (False, str, None) + hotlink_protection setting - automatic_https_rewrites (False, str, None) - automatic_https_rewrites setting + image_load_optimization (False, str, None) + image_load_optimization setting - image_size_optimization (False, str, None) - image_size_optimization setting + script_load_optimization (False, str, None) + script_load_optimization setting - pseudo_ipv4 (False, str, None) - pseudo_ipv4 setting + challenge_ttl (False, int, None) + Challenge TTL setting + + + opportunistic_encryption (False, str, None) + opportunistic_encryption setting id (False, str, None) diff --git a/docs/ibm_cis_edge_functions_trigger.rst b/docs/ibm_cis_edge_functions_trigger.rst index 3dad18936..038d79509 100644 --- a/docs/ibm_cis_edge_functions_trigger.rst +++ b/docs/ibm_cis_edge_functions_trigger.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pattern_url (True, str, None) - (Required for new resource) Edge function trigger pattern - - - action_name (False, str, None) - Edge function trigger action name - - cis_id (True, str, None) (Required for new resource) CIS Intance CRN @@ -47,6 +39,14 @@ Parameters (Required for new resource) CIS Domain ID + pattern_url (True, str, None) + (Required for new resource) Edge function trigger pattern + + + action_name (False, str, None) + Edge function trigger action name + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis_firewall.rst b/docs/ibm_cis_firewall.rst index d7fed0206..beda0547f 100644 --- a/docs/ibm_cis_firewall.rst +++ b/docs/ibm_cis_firewall.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + cis_id (True, str, None) + (Required for new resource) CIS object id + + + domain_id (True, str, None) + (Required for new resource) Associated CIS domain + + firewall_type (True, str, None) (Required for new resource) Type of firewall.Allowable values are access-rules,ua-rules,lockdowns @@ -47,14 +55,6 @@ Parameters User Agent Rule Data - cis_id (True, str, None) - (Required for new resource) CIS object id - - - domain_id (True, str, None) - (Required for new resource) Associated CIS domain - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis_global_load_balancer.rst b/docs/ibm_cis_global_load_balancer.rst index 34c30fa4e..4e39debfa 100644 --- a/docs/ibm_cis_global_load_balancer.rst +++ b/docs/ibm_cis_global_load_balancer.rst @@ -31,56 +31,56 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - description (False, str, None) - Description for the load balancer instance + enabled (False, bool, True) + set to true of LB needs to enabled cis_id (True, str, None) (Required for new resource) CIS instance crn - fallback_pool_id (True, str, None) - (Required for new resource) fallback pool ID - - - ttl (False, int, 60) - TTL value + domain_id (True, str, None) + (Required for new resource) Associated CIS domain - proxied (False, bool, False) - set to true if proxy needs to be enabled + description (False, str, None) + Description for the load balancer instance session_affinity (False, str, none) Session affinity info - enabled (False, bool, True) - set to true of LB needs to enabled + fallback_pool_id (True, str, None) + (Required for new resource) fallback pool ID - region_pools (False, list, None) - None + default_pool_ids (True, list, None) + (Required for new resource) List of default Pool IDs - domain_id (True, str, None) - (Required for new resource) Associated CIS domain + ttl (False, int, 60) + TTL value name (True, str, None) (Required for new resource) name - default_pool_ids (True, list, None) - (Required for new resource) List of default Pool IDs + pop_pools (False, list, None) + None + + + region_pools (False, list, None) + None steering_policy (False, str, None) Steering policy info - pop_pools (False, list, None) - None + proxied (False, bool, False) + set to true if proxy needs to be enabled id (False, str, None) diff --git a/docs/ibm_cis_healthcheck.rst b/docs/ibm_cis_healthcheck.rst index 6b5fe7c0e..8ab4cf102 100644 --- a/docs/ibm_cis_healthcheck.rst +++ b/docs/ibm_cis_healthcheck.rst @@ -31,36 +31,24 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - follow_redirects (False, bool, False) - follow_redirects - - - retries (False, int, 2) - retries - - - interval (False, int, 60) - interval - - - port (False, int, None) - port number - - expected_body (False, str, None) expected_body - expected_codes (False, str, None) - expected_codes + description (False, str, None) + description method (False, str, GET) method - description (False, str, None) - description + follow_redirects (False, bool, False) + follow_redirects + + + port (False, int, None) + port number allow_insecure (False, bool, False) @@ -79,6 +67,14 @@ Parameters path + retries (False, int, 2) + retries + + + expected_codes (False, str, None) + expected_codes + + type (False, str, http) type @@ -87,6 +83,10 @@ Parameters timeout + interval (False, int, 60) + interval + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis_origin_pool.rst b/docs/ibm_cis_origin_pool.rst index 80b1e2458..a58c099dd 100644 --- a/docs/ibm_cis_origin_pool.rst +++ b/docs/ibm_cis_origin_pool.rst @@ -31,40 +31,40 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - minimum_origins (False, int, 1) - Minimum number of Origins + cis_id (True, str, None) + (Required for new resource) CIS instance crn - check_regions (True, list, None) - (Required for new resource) List of regions + description (False, str, None) + Description of the CIS Origin Pool - monitor (False, str, None) - Monitor value + name (True, str, None) + (Required for new resource) name - cis_id (True, str, None) - (Required for new resource) CIS instance crn + minimum_origins (False, int, 1) + Minimum number of Origins - description (False, str, None) - Description of the CIS Origin Pool + origins (True, list, None) + (Required for new resource) Origins info - enabled (True, bool, None) - (Required for new resource) Boolean value set to true if cis origin pool needs to be enabled + check_regions (True, list, None) + (Required for new resource) List of regions - notification_email (False, str, None) - Email address configured to recieve the notifications + enabled (True, bool, None) + (Required for new resource) Boolean value set to true if cis origin pool needs to be enabled - name (True, str, None) - (Required for new resource) name + monitor (False, str, None) + Monitor value - origins (True, list, None) - (Required for new resource) Origins info + notification_email (False, str, None) + Email address configured to recieve the notifications id (False, str, None) diff --git a/docs/ibm_cis_page_rule.rst b/docs/ibm_cis_page_rule.rst index 539bf91bc..34b39c864 100644 --- a/docs/ibm_cis_page_rule.rst +++ b/docs/ibm_cis_page_rule.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + actions (True, list, None) + (Required for new resource) Page rule actions + + cis_id (True, str, None) (Required for new resource) CIS instance crn @@ -51,10 +55,6 @@ Parameters (Required for new resource) Page rule targets - actions (True, list, None) - (Required for new resource) Page rule actions - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis_page_rules_info.rst b/docs/ibm_cis_page_rules_info.rst index de08c78e5..b6c21f743 100644 --- a/docs/ibm_cis_page_rules_info.rst +++ b/docs/ibm_cis_page_rules_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - cis_id (True, str, None) - DNS Zone CRN - - domain_id (True, str, None) DNS Zone ID + cis_id (True, str, None) + DNS Zone CRN + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_cis_range_app.rst b/docs/ibm_cis_range_app.rst index d66a2e77e..d4051ed7c 100644 --- a/docs/ibm_cis_range_app.rst +++ b/docs/ibm_cis_range_app.rst @@ -31,12 +31,20 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + origin_dns (False, str, None) + DNS record pointing to the origin for this Range application. + + traffic_type (False, str, direct) Configure how traffic is handled at the edge. - cis_id (True, str, None) - (Required for new resource) CIS Intance CRN + origin_port (False, int, None) + Port at the origin that listens to traffic + + + proxy_protocol (False, str, None) + Allows for the true client IP to be passed to the service. domain_id (True, str, None) @@ -47,12 +55,8 @@ Parameters (Required for new resource) Defines the protocol and port for this application - edge_ips_connectivity (False, str, all) - Specifies the IP version. - - - ip_firewall (False, bool, None) - Enables the IP Firewall for this application. Only available for TCP applications. + dns (True, str, None) + (Required for new resource) Name of the DNS record for this application dns_type (True, str, None) @@ -63,28 +67,24 @@ Parameters IP address and port of the origin for this Range application. - origin_dns (False, str, None) - DNS record pointing to the origin for this Range application. + tls (False, str, False) + Configure if and how TLS connections are terminated at the edge. - dns (True, str, None) - (Required for new resource) Name of the DNS record for this application + cis_id (True, str, None) + (Required for new resource) CIS Intance CRN - proxy_protocol (False, str, None) - Allows for the true client IP to be passed to the service. + ip_firewall (False, bool, None) + Enables the IP Firewall for this application. Only available for TCP applications. edge_ips_type (False, str, dynamic) The type of edge IP configuration. - origin_port (False, int, None) - Port at the origin that listens to traffic - - - tls (False, str, False) - Configure if and how TLS connections are terminated at the edge. + edge_ips_connectivity (False, str, all) + Specifies the IP version. id (False, str, None) diff --git a/docs/ibm_cis_rate_limit.rst b/docs/ibm_cis_rate_limit.rst index 56e257ed8..a8e9bc5ca 100644 --- a/docs/ibm_cis_rate_limit.rst +++ b/docs/ibm_cis_rate_limit.rst @@ -35,40 +35,40 @@ Parameters (Required for new resource) CIS Intance CRN - domain_id (True, str, None) - (Required for new resource) CIS Domain ID + bypass (False, list, None) + Bypass URL - description (False, str, None) - A note that you can use to describe the reason for a rate limiting rule. + threshold (True, int, None) + (Required for new resource) Rate Limiting Threshold - period (True, int, None) - (Required for new resource) Rate Limiting Period + action (True, list, None) + (Required for new resource) Rate Limiting Action - correlate (False, list, None) - Ratelimiting Correlate + match (False, list, None) + Rate Limiting Match - action (True, list, None) - (Required for new resource) Rate Limiting Action + domain_id (True, str, None) + (Required for new resource) CIS Domain ID disabled (False, bool, False) Whether this rate limiting rule is currently disabled. - bypass (False, list, None) - Bypass URL + description (False, str, None) + A note that you can use to describe the reason for a rate limiting rule. - threshold (True, int, None) - (Required for new resource) Rate Limiting Threshold + period (True, int, None) + (Required for new resource) Rate Limiting Period - match (False, list, None) - Rate Limiting Match + correlate (False, list, None) + Ratelimiting Correlate id (False, str, None) diff --git a/docs/ibm_cis_waf_group.rst b/docs/ibm_cis_waf_group.rst index bbfd36832..62df27c64 100644 --- a/docs/ibm_cis_waf_group.rst +++ b/docs/ibm_cis_waf_group.rst @@ -35,20 +35,20 @@ Parameters (Required for new resource) CIS Intance CRN - mode (True, str, None) - (Required for new resource) WAF Rule group mode on/off - - domain_id (True, str, None) (Required for new resource) CIS Domain ID + group_id (True, str, None) + (Required for new resource) WAF Rule group id + + package_id (True, str, None) (Required for new resource) WAF Rule package id - group_id (True, str, None) - (Required for new resource) WAF Rule group id + mode (True, str, None) + (Required for new resource) WAF Rule group mode on/off id (False, str, None) diff --git a/docs/ibm_cis_waf_groups_info.rst b/docs/ibm_cis_waf_groups_info.rst index cc1624e21..dc9c9990a 100644 --- a/docs/ibm_cis_waf_groups_info.rst +++ b/docs/ibm_cis_waf_groups_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + domain_id (True, str, None) + CIS Domain ID + + package_id (True, str, None) WAF Rule package id @@ -37,10 +41,6 @@ Parameters CIS Intance CRN - domain_id (True, str, None) - CIS Domain ID - - iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_cis_waf_package.rst b/docs/ibm_cis_waf_package.rst index 6ab42275d..8c347c7fb 100644 --- a/docs/ibm_cis_waf_package.rst +++ b/docs/ibm_cis_waf_package.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + sensitivity (True, str, None) + (Required for new resource) WAF pakcage sensitivity + + + action_mode (True, str, None) + (Required for new resource) WAF pakcage action mode + + cis_id (True, str, None) (Required for new resource) CIS Intance CRN @@ -43,14 +51,6 @@ Parameters (Required for new resource) WAF pakcage ID - sensitivity (True, str, None) - (Required for new resource) WAF pakcage sensitivity - - - action_mode (True, str, None) - (Required for new resource) WAF pakcage action mode - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cis_waf_rule.rst b/docs/ibm_cis_waf_rule.rst index 8cfec1844..cffc7195e 100644 --- a/docs/ibm_cis_waf_rule.rst +++ b/docs/ibm_cis_waf_rule.rst @@ -35,22 +35,22 @@ Parameters (Required for new resource) CIS Domain ID - package_id (True, str, None) - (Required for new resource) CIS WAF Rule package id - - - cis_id (True, str, None) - (Required for new resource) CIS Intance CRN - - rule_id (True, str, None) (Required for new resource) CIS WAF Rule id + package_id (True, str, None) + (Required for new resource) CIS WAF Rule package id + + mode (True, str, None) (Required for new resource) CIS WAF Rule mode + cis_id (True, str, None) + (Required for new resource) CIS Intance CRN + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cloud_shell_account_settings.rst b/docs/ibm_cloud_shell_account_settings.rst index 113dba8fe..5357e956c 100644 --- a/docs/ibm_cloud_shell_account_settings.rst +++ b/docs/ibm_cloud_shell_account_settings.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + account_id (True, str, None) + (Required for new resource) The account ID in which the account settings belong to. + + + rev (False, str, None) + Unique revision number for the settings object. + + default_enable_new_features (False, bool, None) You can choose which Cloud Shell features are available in the account and whether any new features are enabled as they become available. The feature settings apply only to the enabled Cloud Shell locations. @@ -47,14 +55,6 @@ Parameters List of Cloud Shell features. - account_id (True, str, None) - (Required for new resource) The account ID in which the account settings belong to. - - - rev (False, str, None) - Unique revision number for the settings object. - - regions (False, list, None) List of Cloud Shell region settings. diff --git a/docs/ibm_cloudant.rst b/docs/ibm_cloudant.rst index e7b2a8a98..69f679127 100644 --- a/docs/ibm_cloudant.rst +++ b/docs/ibm_cloudant.rst @@ -31,62 +31,62 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - resource_group_id (False, str, None) - The resource group id - - plan (True, str, None) (Required for new resource) The plan type of the service - include_data_events (False, bool, False) - Include data event types in events sent to IBM Cloud Activity Tracker with LogDNA for the IBM Cloudant instance. By default only emitted events are of "management" type. + service_endpoints (False, str, None) + Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. cors_config (False, list, None) Configuration for CORS. - location (True, str, None) - (Required for new resource) The location where the instance available - - environment_crn (False, str, None) CRN of the IBM Cloudant Dedicated Hardware plan instance - parameters (False, dict, None) - Arbitrary parameters to pass. Must be a JSON object - - - parameters_json (False, str, None) - Arbitrary parameters to pass in Json string format + name (True, str, None) + (Required for new resource) A name for the resource instance legacy_credentials (False, bool, False) Use both legacy credentials and IAM for authentication - capacity (False, int, 1) - A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global queries/sec of provisioned throughput capacity. + location (True, str, None) + (Required for new resource) The location where the instance available - name (True, str, None) - (Required for new resource) A name for the resource instance + parameters (False, dict, None) + Arbitrary parameters to pass. Must be a JSON object - tags (False, list, None) - None + include_data_events (False, bool, False) + Include data event types in events sent to IBM Cloud Activity Tracker with LogDNA for the IBM Cloudant instance. By default only emitted events are of "management" type. - service_endpoints (False, str, None) - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. + capacity (False, int, 1) + A number of blocks of throughput units. A block consists of 100 reads/sec, 50 writes/sec, and 5 global queries/sec of provisioned throughput capacity. enable_cors (False, bool, True) Boolean value to turn CORS on and off. + resource_group_id (False, str, None) + The resource group id + + + parameters_json (False, str, None) + Arbitrary parameters to pass in Json string format + + + tags (False, list, None) + None + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cm_catalog.rst b/docs/ibm_cm_catalog.rst index c44698edc..22edd04f5 100644 --- a/docs/ibm_cm_catalog.rst +++ b/docs/ibm_cm_catalog.rst @@ -31,30 +31,30 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - kind (False, str, offering) - Kind of catalog, offering or vpe. + catalog_icon_url (False, str, None) + URL for an icon associated with this catalog. short_description (False, str, None) Description in the requested language. - catalog_icon_url (False, str, None) - URL for an icon associated with this catalog. + label (True, str, None) + (Required for new resource) Display Name in the requested language. tags (False, list, None) List of tags associated with this catalog. - label (True, str, None) - (Required for new resource) Display Name in the requested language. - - resource_group_id (False, str, None) Resource Group ID + kind (False, str, offering) + Kind of catalog, offering or vpe. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cm_offering.rst b/docs/ibm_cm_offering.rst index 6beb4bbad..854a26fa6 100644 --- a/docs/ibm_cm_offering.rst +++ b/docs/ibm_cm_offering.rst @@ -31,16 +31,16 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - catalog_id (True, str, None) - (Required for new resource) The id of the catalog containing this offering. + tags (False, list, None) + List of tags associated with this catalog. label (True, str, None) (Required for new resource) Display Name in the requested language. - tags (False, list, None) - List of tags associated with this catalog. + catalog_id (True, str, None) + (Required for new resource) The id of the catalog containing this offering. id (False, str, None) diff --git a/docs/ibm_cm_offering_instance.rst b/docs/ibm_cm_offering_instance.rst index b4eff3800..679b1abc4 100644 --- a/docs/ibm_cm_offering_instance.rst +++ b/docs/ibm_cm_offering_instance.rst @@ -31,58 +31,58 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - cluster_namespaces (True, list, None) - (Required for new resource) List of target namespaces to install into. - - - label (True, str, None) - (Required for new resource) the label for this instance. + cluster_id (True, str, None) + (Required for new resource) Cluster ID. - version (True, str, None) - (Required for new resource) The version this instance was installed from (not version id). + cluster_all_namespaces (True, bool, None) + (Required for new resource) designate to install into all namespaces. catalog_id (True, str, None) (Required for new resource) Catalog ID this instance was created from. - cluster_region (True, str, None) - (Required for new resource) Cluster region (e.g., us-south). - - resource_group_id (False, str, None) id of the resource group - install_plan (False, str, None) - install plan for the subscription of the operator- can be either automatic or manual. Required for operator bundles - - channel (False, str, None) channel to target for the operator subscription. Required for operator bundles - wait_until_successful (False, bool, True) - Whether to wait until the offering instance successfully provisions, or to return when accepted - - - cluster_id (True, str, None) - (Required for new resource) Cluster ID. - - - cluster_all_namespaces (True, bool, None) - (Required for new resource) designate to install into all namespaces. + label (True, str, None) + (Required for new resource) the label for this instance. offering_id (True, str, None) (Required for new resource) Offering ID this instance was created from. + cluster_namespaces (True, list, None) + (Required for new resource) List of target namespaces to install into. + + kind_format (True, str, None) (Required for new resource) the format this instance has (helm, operator, ova...). + version (True, str, None) + (Required for new resource) The version this instance was installed from (not version id). + + + cluster_region (True, str, None) + (Required for new resource) Cluster region (e.g., us-south). + + + install_plan (False, str, None) + install plan for the subscription of the operator- can be either automatic or manual. Required for operator bundles + + + wait_until_successful (False, bool, True) + Whether to wait until the offering instance successfully provisions, or to return when accepted + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cm_version.rst b/docs/ibm_cm_version.rst index ae9831d37..3fe53b134 100644 --- a/docs/ibm_cm_version.rst +++ b/docs/ibm_cm_version.rst @@ -35,28 +35,28 @@ Parameters (Required for new resource) Catalog identifier. - offering_id (True, str, None) - (Required for new resource) Offering identification. + content (False, str, None) + byte array representing the content to be imported. Only supported for OVA images at this time. zipurl (False, str, None) URL path to zip location. If not specified, must provide content in the body of this call. - target_version (False, str, None) - The semver value for this new version, if not found in the zip url package content. + tags (False, list, None) + Tags array. - target_kinds (False, list, None) - Target kinds. Current valid values are 'iks', 'roks', 'vcenter', and 'terraform'. + target_version (False, str, None) + The semver value for this new version, if not found in the zip url package content. - tags (False, list, None) - Tags array. + offering_id (True, str, None) + (Required for new resource) Offering identification. - content (False, str, None) - byte array representing the content to be imported. Only supported for OVA images at this time. + target_kinds (False, list, None) + Target kinds. Current valid values are 'iks', 'roks', 'vcenter', and 'terraform'. id (False, str, None) diff --git a/docs/ibm_compute_autoscale_group.rst b/docs/ibm_compute_autoscale_group.rst index 4cca2f889..4fd940b9c 100644 --- a/docs/ibm_compute_autoscale_group.rst +++ b/docs/ibm_compute_autoscale_group.rst @@ -31,40 +31,32 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - port (False, int, None) - Port number + minimum_member_count (True, int, None) + (Required for new resource) Minimum member count health_check (False, dict, None) None - network_vlan_ids (False, list, None) - List of network VLAN ids - - - name (True, str, None) - (Required for new resource) Name - - - minimum_member_count (True, int, None) - (Required for new resource) Minimum member count - - - cooldown (True, int, None) - (Required for new resource) Cooldown value + tags (False, list, None) + List of tags virtual_server_id (False, int, None) virtual server ID + port (False, int, None) + Port number + + virtual_guest_member_template (True, list, None) (Required for new resource) Virtual guest member template - tags (False, list, None) - List of tags + name (True, str, None) + (Required for new resource) Name regional_group (True, str, None) @@ -75,10 +67,18 @@ Parameters (Required for new resource) Maximum member count + cooldown (True, int, None) + (Required for new resource) Cooldown value + + termination_policy (True, str, None) (Required for new resource) Termination policy + network_vlan_ids (False, list, None) + List of network VLAN ids + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_compute_autoscale_policy.rst b/docs/ibm_compute_autoscale_policy.rst index 79bce97de..7188feb3c 100644 --- a/docs/ibm_compute_autoscale_policy.rst +++ b/docs/ibm_compute_autoscale_policy.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) Name - - - scale_type (True, str, None) - (Required for new resource) scale type - - scale_amount (True, int, None) (Required for new resource) Scale amount @@ -59,6 +51,14 @@ Parameters List of tags + name (True, str, None) + (Required for new resource) Name + + + scale_type (True, str, None) + (Required for new resource) scale type + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_compute_bare_metal.rst b/docs/ibm_compute_bare_metal.rst index e07aee2bf..bcb67543c 100644 --- a/docs/ibm_compute_bare_metal.rst +++ b/docs/ibm_compute_bare_metal.rst @@ -31,59 +31,39 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - os_reference_code (False, str, None) - OS refernece code value - - - tcp_monitoring (False, bool, False) - TCP monitoring enabled if set as true - - - package_key_name (False, str, None) + gpu_secondary_key_name (False, str, None) None - redundant_network (False, bool, False) + unbonded_network (False, bool, False) None - memory (False, int, None) + restricted_network (False, bool, False) None - hostname (False, str, None) - Host name - - block_storage_ids (False, list, None) None - fixed_config_preset (False, str, None) - Fixed config preset value + image_template_id (False, int, None) + OS image template ID - ipv6_enabled (False, bool, False) - Boolean value true if IPV6 ia enabled or false + network_speed (False, int, 100) + Network speed in MBPS - gpu_secondary_key_name (False, str, None) - None + tcp_monitoring (False, bool, False) + TCP monitoring enabled if set as true extended_hardware_testing (False, bool, False) None - public_bandwidth (False, int, None) - None - - - gpu_key_name (False, str, None) - None - - - restricted_network (False, bool, False) + private_subnet (False, str, None) None @@ -91,11 +71,15 @@ Parameters (Required for new resource) Domain name - user_metadata (False, str, None) - User metadata info + ssh_key_ids (False, list, None) + SSH KEY IDS list - software_guard_extensions (False, bool, False) + tags (False, list, None) + None + + + private_vlan_id (False, int, None) None @@ -103,40 +87,36 @@ Parameters boolean value true if ipv6 static is enabled else false - public_vlan_id (False, int, None) - None + hourly_billing (False, bool, True) + Enables hourly billing - private_subnet (False, str, None) + package_key_name (False, str, None) None - notes (False, str, None) - Optional notes info - - - tags (False, list, None) + os_key_name (False, str, None) None - unbonded_network (False, bool, False) + public_bandwidth (False, int, None) None - private_vlan_id (False, int, None) + storage_groups (False, list, None) None - hourly_billing (False, bool, True) - Enables hourly billing + public_subnet (False, str, None) + None - private_network_only (False, bool, False) - only private network configured if is true + hostname (False, str, None) + Host name - storage_groups (False, list, None) - None + fixed_config_preset (False, str, None) + Fixed config preset value redundant_power_supply (False, bool, None) @@ -147,48 +127,68 @@ Parameters None - secondary_ip_count (False, int, None) - Secondary IP addresses count + quote_id (False, int, None) + Quote ID for Quote based provisioning - ssh_key_ids (False, list, None) - SSH KEY IDS list + public_vlan_id (False, int, None) + None - image_template_id (False, int, None) - OS image template ID + ipv6_enabled (False, bool, False) + Boolean value true if IPV6 ia enabled or false - datacenter (False, str, None) + notes (False, str, None) + Optional notes info + + + post_install_script_uri (False, str, None) None - process_key_name (False, str, None) + os_reference_code (False, str, None) + OS refernece code value + + + private_network_only (False, bool, False) + only private network configured if is true + + + user_metadata (False, str, None) + User metadata info + + + file_storage_ids (False, list, None) None - os_key_name (False, str, None) + datacenter (False, str, None) None - quote_id (False, int, None) - Quote ID for Quote based provisioning + redundant_network (False, bool, False) + None - public_subnet (False, str, None) + memory (False, int, None) None - file_storage_ids (False, list, None) + secondary_ip_count (False, int, None) + Secondary IP addresses count + + + software_guard_extensions (False, bool, False) None - post_install_script_uri (False, str, None) + process_key_name (False, str, None) None - network_speed (False, int, 100) - Network speed in MBPS + gpu_key_name (False, str, None) + None id (False, str, None) diff --git a/docs/ibm_compute_bare_metal_info.rst b/docs/ibm_compute_bare_metal_info.rst index 5a573bd24..e1c20d859 100644 --- a/docs/ibm_compute_bare_metal_info.rst +++ b/docs/ibm_compute_bare_metal_info.rst @@ -29,20 +29,20 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - domain (False, str, None) - The domain of the bare metal server + most_recent (False, bool, False) + If true and multiple entries are found, the most recently created bare metal is used. If false, an error is returned - global_identifier (False, str, None) - The unique global identifier of the bare metal server + domain (False, str, None) + The domain of the bare metal server hostname (False, str, None) The hostname of the bare metal server - most_recent (False, bool, False) - If true and multiple entries are found, the most recently created bare metal is used. If false, an error is returned + global_identifier (False, str, None) + The unique global identifier of the bare metal server iaas_classic_username (False, any, None) diff --git a/docs/ibm_compute_dedicated_host.rst b/docs/ibm_compute_dedicated_host.rst index af147d012..dd07a9f64 100644 --- a/docs/ibm_compute_dedicated_host.rst +++ b/docs/ibm_compute_dedicated_host.rst @@ -31,8 +31,12 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - domain (True, str, None) - (Required for new resource) The domain of dedicatated host. + wait_time_minutes (False, int, 90) + None + + + tags (False, list, None) + None datacenter (True, str, None) @@ -43,24 +47,20 @@ Parameters (Required for new resource) The hostname of the primary router that the dedicated host is associated with. - hostname (True, str, None) - (Required for new resource) The host name of dedicatated host. - - - flavor (False, str, 56_CORES_X_242_RAM_X_1_4_TB) - The flavor of the dedicatated host. - - hourly_billing (False, bool, True) The billing type for the dedicatated host. - wait_time_minutes (False, int, 90) - None + hostname (True, str, None) + (Required for new resource) The host name of dedicatated host. - tags (False, list, None) - None + domain (True, str, None) + (Required for new resource) The domain of dedicatated host. + + + flavor (False, str, 56_CORES_X_242_RAM_X_1_4_TB) + The flavor of the dedicatated host. id (False, str, None) diff --git a/docs/ibm_compute_monitor.rst b/docs/ibm_compute_monitor.rst index ec0dc2a4c..d446b7d89 100644 --- a/docs/ibm_compute_monitor.rst +++ b/docs/ibm_compute_monitor.rst @@ -31,6 +31,18 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + guest_id (True, int, None) + (Required for new resource) Guest ID + + + ip_address (False, str, None) + IP Address + + + query_type_id (True, int, None) + (Required for new resource) Query Type ID + + response_action_id (True, int, None) (Required for new resource) Response action ID @@ -47,18 +59,6 @@ Parameters List of tags - guest_id (True, int, None) - (Required for new resource) Guest ID - - - ip_address (False, str, None) - IP Address - - - query_type_id (True, int, None) - (Required for new resource) Query Type ID - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_compute_placement_group.rst b/docs/ibm_compute_placement_group.rst index b5b923052..5d301e788 100644 --- a/docs/ibm_compute_placement_group.rst +++ b/docs/ibm_compute_placement_group.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + datacenter (True, str, None) + (Required for new resource) Dataceneter name + + pod (True, str, None) (Required for new resource) Pod name @@ -47,10 +51,6 @@ Parameters List of tags - datacenter (True, str, None) - (Required for new resource) Dataceneter name - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_compute_provisioning_hook.rst b/docs/ibm_compute_provisioning_hook.rst index a001a88f2..d45495bd1 100644 --- a/docs/ibm_compute_provisioning_hook.rst +++ b/docs/ibm_compute_provisioning_hook.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + tags (False, list, None) + Tags associated with resource + + name (True, str, None) (Required for new resource) Provision hook name @@ -39,10 +43,6 @@ Parameters (Required for new resource) URI of the hook - tags (False, list, None) - Tags associated with resource - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_compute_reserved_capacity.rst b/docs/ibm_compute_reserved_capacity.rst index 05f88a058..706c29c67 100644 --- a/docs/ibm_compute_reserved_capacity.rst +++ b/docs/ibm_compute_reserved_capacity.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + tags (False, list, None) + List of tags + + + force_create (False, bool, None) + Force the creation of reserved capacity with same name + + datacenter (True, str, None) (Required for new resource) Dataceneter name @@ -51,14 +59,6 @@ Parameters (Required for new resource) flavor of the reserved capacity - tags (False, list, None) - List of tags - - - force_create (False, bool, None) - Force the creation of reserved capacity with same name - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_compute_ssh_key.rst b/docs/ibm_compute_ssh_key.rst index dd49f22c6..6566be5ce 100644 --- a/docs/ibm_compute_ssh_key.rst +++ b/docs/ibm_compute_ssh_key.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - label (True, str, None) - (Required for new resource) SSH Key label - - public_key (True, str, None) (Required for new resource) Plublic Key info @@ -47,6 +43,10 @@ Parameters List of tags for the resource + label (True, str, None) + (Required for new resource) SSH Key label + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_compute_ssh_key_info.rst b/docs/ibm_compute_ssh_key_info.rst index a9c3a9f6f..c5dfffb67 100644 --- a/docs/ibm_compute_ssh_key_info.rst +++ b/docs/ibm_compute_ssh_key_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - most_recent (False, bool, False) - If true and multiple entries are found, the most recently created key is used. If false, an error is returned - - label (True, str, None) The label associated with the ssh key + most_recent (False, bool, False) + If true and multiple entries are found, the most recently created key is used. If false, an error is returned + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_compute_ssl_certificate.rst b/docs/ibm_compute_ssl_certificate.rst index af97d3ed1..42acb1b5b 100644 --- a/docs/ibm_compute_ssl_certificate.rst +++ b/docs/ibm_compute_ssl_certificate.rst @@ -31,22 +31,22 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - certificate (True, str, None) - (Required for new resource) SSL Certifcate - - intermediate_certificate (False, str, None) Intermediate certificate value - private_key (True, str, None) - (Required for new resource) SSL Private Key - - tags (False, list, None) Tags set for resource + certificate (True, str, None) + (Required for new resource) SSL Certifcate + + + private_key (True, str, None) + (Required for new resource) SSL Private Key + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_compute_user.rst b/docs/ibm_compute_user.rst index a15642143..c2e61a09a 100644 --- a/docs/ibm_compute_user.rst +++ b/docs/ibm_compute_user.rst @@ -31,72 +31,72 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - email (True, str, None) - (Required for new resource) email address of the user - - - country (True, str, None) - (Required for new resource) Country name - - - timezone (True, str, None) - (Required for new resource) time zone info + user_status (False, str, ACTIVE) + user status info - first_name (True, str, None) - (Required for new resource) First name of the user + company_name (True, str, None) + (Required for new resource) comapany name address1 (True, str, None) (Required for new resource) Address info of the user - address2 (False, str, None) - Address info of the user + state_ (True, str, None) + (Required for new resource) Satate name + + + country (True, str, None) + (Required for new resource) Country name password (False, str, None) password for the user - api_key (False, str, None) - API key for the user + last_name (True, str, None) + (Required for new resource) Last name of the user - username (False, str, None) - user name + email (True, str, None) + (Required for new resource) email address of the user - last_name (True, str, None) - (Required for new resource) Last name of the user + address2 (False, str, None) + Address info of the user permissions (False, list, None) set of persmissions assigned for the user + api_key (False, str, None) + API key for the user + + tags (False, list, None) Tags set for the resources - company_name (True, str, None) - (Required for new resource) comapany name + username (False, str, None) + user name - city (True, str, None) - (Required for new resource) City name + first_name (True, str, None) + (Required for new resource) First name of the user - state_ (True, str, None) - (Required for new resource) Satate name + has_api_key (False, bool, False) + API Key info of the user - user_status (False, str, ACTIVE) - user status info + city (True, str, None) + (Required for new resource) City name - has_api_key (False, bool, False) - API Key info of the user + timezone (True, str, None) + (Required for new resource) time zone info id (False, str, None) diff --git a/docs/ibm_compute_vm_instance.rst b/docs/ibm_compute_vm_instance.rst index b0d05709f..dceef5386 100644 --- a/docs/ibm_compute_vm_instance.rst +++ b/docs/ibm_compute_vm_instance.rst @@ -31,99 +31,103 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - tags (False, list, None) + public_bandwidth_limited (False, int, None) None - ipv6_static_enabled (False, bool, False) + domain (False, str, None) None - placement_group_id (False, int, None) - The placement group id + memory (False, int, None) + None - cores (False, int, None) + network_speed (False, int, 100) None - disks (False, list, None) + block_storage_ids (False, list, None) None - datacenter (False, str, None) + user_metadata (False, str, None) None - datacenter_choice (False, list, None) - The user provided datacenter options + dedicated_acct_host_only (False, bool, None) + None - public_security_group_ids (False, list, None) + transient (False, bool, None) None - private_security_group_ids (False, list, None) + image_id (False, int, None) None - network_speed (False, int, 100) + hourly_billing (False, bool, True) None - ipv6_enabled (False, bool, False) - None + placement_group_name (False, str, None) + The placement group name - dedicated_host_id (False, int, None) + private_vlan_id (False, int, None) None - dedicated_host_name (False, str, None) + tags (False, list, None) None - public_bandwidth_unlimited (False, bool, False) - None + quote_id (False, int, None) + Quote ID for Quote based provisioning - evault (False, int, None) + public_vlan_id (False, int, None) None - reserved_instance_primary_disk (False, int, None) - The primary disk of reserved instance + private_subnet (False, str, None) + None - memory (False, int, None) + evault (False, int, None) None - placement_group_name (False, str, None) - The placement group name + ssh_key_ids (False, list, None) + None - hostname (False, str, None) + public_security_group_ids (False, list, None) None - bulk_vms (False, list, None) + reserved_capacity_name (False, str, None) + The reserved group id + + + dedicated_host_name (False, str, None) None - private_network_only (False, bool, False) + file_storage_ids (False, list, None) None - public_bandwidth_limited (False, int, None) + datacenter (False, str, None) None - os_reference_code (False, str, None) + public_subnet (False, str, None) None - file_storage_ids (False, list, None) + ipv6_static_enabled (False, bool, False) None @@ -131,27 +135,27 @@ Parameters None - ssh_key_ids (False, list, None) + private_network_only (False, bool, False) None - secondary_ip_count (False, int, None) - None + placement_group_id (False, int, None) + The placement group id - public_vlan_id (False, int, None) + notes (False, str, None) None - private_subnet (False, str, None) + local_disk (False, bool, True) None - image_id (False, int, None) + bulk_vms (False, list, None) None - reserved_capacity_name (False, str, None) + reserved_capacity_id (False, int, None) The reserved group id @@ -159,52 +163,48 @@ Parameters Flavor key name used to provision vm. - notes (False, str, None) + disks (False, list, None) None - private_vlan_id (False, int, None) + ipv6_enabled (False, bool, False) None - block_storage_ids (False, list, None) + hostname (False, str, None) None - public_subnet (False, str, None) + os_reference_code (False, str, None) None - user_metadata (False, str, None) - None + reserved_instance_primary_disk (False, int, None) + The primary disk of reserved instance - domain (False, str, None) + dedicated_host_id (False, int, None) None - dedicated_acct_host_only (False, bool, None) + secondary_ip_count (False, int, None) None - quote_id (False, int, None) - Quote ID for Quote based provisioning - - - transient (False, bool, None) + public_bandwidth_unlimited (False, bool, False) None - hourly_billing (False, bool, True) + cores (False, int, None) None - reserved_capacity_id (False, int, None) - The reserved group id + private_security_group_ids (False, list, None) + None - local_disk (False, bool, True) - None + datacenter_choice (False, list, None) + The user provided datacenter options id (False, str, None) diff --git a/docs/ibm_compute_vm_instance_info.rst b/docs/ibm_compute_vm_instance_info.rst index d34ab63a3..b0c5833b7 100644 --- a/docs/ibm_compute_vm_instance_info.rst +++ b/docs/ibm_compute_vm_instance_info.rst @@ -33,14 +33,14 @@ Parameters The domain of the virtual guest - most_recent (False, bool, False) - If true and multiple entries are found, the most recently created virtual guest is used. If false, an error is returned - - hostname (True, str, None) The hostname of the virtual guest + most_recent (False, bool, False) + If true and multiple entries are found, the most recently created virtual guest is used. If false, an error is returned + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_container_addons.rst b/docs/ibm_container_addons.rst index 2343251d6..3a328f7b0 100644 --- a/docs/ibm_container_addons.rst +++ b/docs/ibm_container_addons.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + addons (True, list, None) + (Required for new resource) + + cluster (True, str, None) (Required for new resource) Cluster Name or ID @@ -39,10 +43,6 @@ Parameters ID of the resource group. - addons (True, list, None) - (Required for new resource) - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_container_alb.rst b/docs/ibm_container_alb.rst index 3fa285002..c4ba10436 100644 --- a/docs/ibm_container_alb.rst +++ b/docs/ibm_container_alb.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - user_ip (False, str, None) - IP assigned by the user - - disable_deployment (False, bool, None) Set to true if ALB needs to be disabled @@ -43,6 +39,10 @@ Parameters (Required for new resource) ALB ID + user_ip (False, str, None) + IP assigned by the user + + enable (False, bool, None) set to true if ALB needs to be enabled diff --git a/docs/ibm_container_alb_cert.rst b/docs/ibm_container_alb_cert.rst index be1bc018c..b2dfc2970 100644 --- a/docs/ibm_container_alb_cert.rst +++ b/docs/ibm_container_alb_cert.rst @@ -31,24 +31,24 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - secret_name (True, str, None) - (Required for new resource) Secret name - - - persistence (False, bool, None) - Persistence of secret - - cert_crn (True, str, None) (Required for new resource) Certificate CRN id + namespace (False, str, ibm-cert-store) + Namespace of the secret + + cluster_id (True, str, None) (Required for new resource) Cluster ID - namespace (False, str, ibm-cert-store) - Namespace of the secret + secret_name (True, str, None) + (Required for new resource) Secret name + + + persistence (False, bool, None) + Persistence of secret id (False, str, None) diff --git a/docs/ibm_container_alb_create.rst b/docs/ibm_container_alb_create.rst index b98351010..b56bbc55d 100644 --- a/docs/ibm_container_alb_create.rst +++ b/docs/ibm_container_alb_create.rst @@ -31,8 +31,8 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - zone (True, str, None) - (Required for new resource) The zone where you want to deploy the ALB. + enable (False, bool, True) + If set to true, the ALB is enabled by default. ip (False, str, None) @@ -43,24 +43,24 @@ Parameters The version of the network load balancer that you want to use for the ALB. - enable (False, bool, True) - If set to true, the ALB is enabled by default. - - - cluster (True, str, None) - (Required for new resource) The ID of the cluster that the ALB belongs to. + ingress_image (False, str, None) + The type of Ingress image that you want to use for your ALB deployment. vlan_id (True, str, None) (Required for new resource) The VLAN ID that you want to use for your ALBs. + cluster (True, str, None) + (Required for new resource) The ID of the cluster that the ALB belongs to. + + alb_type (True, str, None) (Required for new resource) The type of ALB that you want to create. - ingress_image (False, str, None) - The type of Ingress image that you want to use for your ALB deployment. + zone (True, str, None) + (Required for new resource) The zone where you want to deploy the ALB. id (False, str, None) diff --git a/docs/ibm_container_api_key_reset.rst b/docs/ibm_container_api_key_reset.rst index cff3fefb0..742153b39 100644 --- a/docs/ibm_container_api_key_reset.rst +++ b/docs/ibm_container_api_key_reset.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + reset_api_key (False, int, 1) + Determines if apikey has to be reset or not + + region (True, str, None) (Required for new resource) Region which api key has to be reset @@ -39,10 +43,6 @@ Parameters ID of Resource Group - reset_api_key (False, int, 1) - Determines if apikey has to be reset or not - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_container_bind_service.rst b/docs/ibm_container_bind_service.rst index 09ff26efe..5b4f74c5c 100644 --- a/docs/ibm_container_bind_service.rst +++ b/docs/ibm_container_bind_service.rst @@ -31,16 +31,20 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - service_instance_name (False, str, None) - serivice instance name + role (False, str, None) + Role info + + + cluster_name_id (True, str, None) + (Required for new resource) Cluster name or ID namespace_id (True, str, None) (Required for new resource) namespace ID - role (False, str, None) - Role info + key (False, str, None) + Key info resource_group_id (False, str, None) @@ -51,18 +55,14 @@ Parameters List of tags for the resource - cluster_name_id (True, str, None) - (Required for new resource) Cluster name or ID + service_instance_name (False, str, None) + serivice instance name service_instance_id (False, str, None) Service instance ID - key (False, str, None) - Key info - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_container_bind_service_info.rst b/docs/ibm_container_bind_service_info.rst index 673601b2f..b5e7ab27d 100644 --- a/docs/ibm_container_bind_service_info.rst +++ b/docs/ibm_container_bind_service_info.rst @@ -29,10 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - service_instance_name (False, str, None) - serivice instance name - - namespace_id (True, str, None) namespace ID @@ -45,6 +41,10 @@ Parameters Service instance ID + service_instance_name (False, str, None) + serivice instance name + + ibmcloud_api_key (True, any, None) The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'. diff --git a/docs/ibm_container_cluster.rst b/docs/ibm_container_cluster.rst index fd1ef3e09..2b4e26000 100644 --- a/docs/ibm_container_cluster.rst +++ b/docs/ibm_container_cluster.rst @@ -31,124 +31,124 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - datacenter (True, str, None) - (Required for new resource) The datacenter where this cluster will be deployed + kube_version (False, str, None) + Kubernetes version info - default_pool_size (False, int, 1) - The size of the default worker pool + service_subnet (False, str, None) + Custom subnet CIDR to provide private IP addresses for services - taints (False, list, None) - WorkerPool Taints + no_subnet (False, bool, False) + Boolean value set to true when subnet creation is not required. force_delete_storage (False, bool, False) Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered - tags (False, list, None) - Tags for the resource - - - disk_encryption (False, bool, True) - disc encryption done, if set to true. - - - retry_patch_version (False, int, None) - Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails + private_service_endpoint (False, bool, None) + None - update_all_workers (False, bool, False) - Updates all the woker nodes if sets to true + datacenter (True, str, None) + (Required for new resource) The datacenter where this cluster will be deployed - wait_till (False, str, IngressReady) - wait_till can be configured for Master Ready, One worker Ready or Ingress Ready + workers_info (False, list, None) + The IDs of the worker node - machine_type (False, str, None) - Machine type + resource_group_id (False, str, None) + ID of the resource group. hardware (True, str, None) (Required for new resource) Hardware type - private_vlan_id (False, str, None) - Private VLAN ID + subnet_id (False, list, None) + List of subnet IDs - labels (False, dict, None) - list of labels to the default worker pool + webhook (False, list, None) + None - resource_group_id (False, str, None) - ID of the resource group. + labels (False, dict, None) + list of labels to the default worker pool - webhook (False, list, None) - None + disk_encryption (False, bool, True) + disc encryption done, if set to true. - gateway_enabled (False, bool, False) - Set true for gateway enabled clusters + patch_version (False, str, None) + Kubernetes patch version - pod_subnet (False, str, None) - Custom subnet CIDR to provide private IP addresses for pods + retry_patch_version (False, int, None) + Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails - no_subnet (False, bool, False) - Boolean value set to true when subnet creation is not required. + machine_type (False, str, None) + Machine type name (True, str, None) (Required for new resource) The cluster name - kube_version (False, str, None) - Kubernetes version info + kms_config (False, list, None) + Enables KMS on a given cluster - entitlement (False, str, None) - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + gateway_enabled (False, bool, False) + Set true for gateway enabled clusters - public_service_endpoint (False, bool, None) - None + public_vlan_id (False, str, None) + Public VLAN ID - patch_version (False, str, None) - Kubernetes patch version + pod_subnet (False, str, None) + Custom subnet CIDR to provide private IP addresses for pods - public_vlan_id (False, str, None) - Public VLAN ID + private_vlan_id (False, str, None) + Private VLAN ID - private_service_endpoint (False, bool, None) - None + default_pool_size (False, int, 1) + The size of the default worker pool - service_subnet (False, str, None) - Custom subnet CIDR to provide private IP addresses for services + wait_for_worker_update (False, bool, True) + Wait for worker node to update during kube version update. - subnet_id (False, list, None) - List of subnet IDs + wait_till (False, str, IngressReady) + wait_till can be configured for Master Ready, One worker Ready or Ingress Ready - kms_config (False, list, None) - Enables KMS on a given cluster + tags (False, list, None) + Tags for the resource - workers_info (False, list, None) - The IDs of the worker node + public_service_endpoint (False, bool, None) + None - wait_for_worker_update (False, bool, True) - Wait for worker node to update during kube version update. + taints (False, list, None) + WorkerPool Taints + + + entitlement (False, str, None) + Entitlement option reduces additional OCP Licence cost in Openshift Clusters + + + update_all_workers (False, bool, False) + Updates all the woker nodes if sets to true id (False, str, None) diff --git a/docs/ibm_container_cluster_config_info.rst b/docs/ibm_container_cluster_config_info.rst index a440baf80..655cbe438 100644 --- a/docs/ibm_container_cluster_config_info.rst +++ b/docs/ibm_container_cluster_config_info.rst @@ -33,8 +33,8 @@ Parameters The name/id of the cluster - download (False, bool, True) - If set to false will not download the config, otherwise they are downloaded each time but onto the same path for a given cluster name/id + network (False, bool, False) + If set to true will download the Calico network config with the Admin config config_dir (False, str, None) @@ -49,8 +49,8 @@ Parameters If set to true will download the config for admin - network (False, bool, False) - If set to true will download the Calico network config with the Admin config + download (False, bool, True) + If set to false will not download the config, otherwise they are downloaded each time but onto the same path for a given cluster name/id ibmcloud_api_key (True, any, None) diff --git a/docs/ibm_container_cluster_feature.rst b/docs/ibm_container_cluster_feature.rst index 0873a6c34..3f7b2e122 100644 --- a/docs/ibm_container_cluster_feature.rst +++ b/docs/ibm_container_cluster_feature.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + resource_group_id (False, str, None) + ID of the resource group. + + cluster (True, str, None) (Required for new resource) Cluster name of ID @@ -51,10 +55,6 @@ Parameters Boolean value set true if worker nodes to be reloaded - resource_group_id (False, str, None) - ID of the resource group. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_container_cluster_info.rst b/docs/ibm_container_cluster_info.rst index c1898c347..c9103e746 100644 --- a/docs/ibm_container_cluster_info.rst +++ b/docs/ibm_container_cluster_info.rst @@ -29,22 +29,22 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - resource_group_id (False, str, None) - ID of the resource group. + list_bounded_services (False, bool, True) + If set to false bounded services won't be listed. name (False, str, None) Name or id of the cluster - list_bounded_services (False, bool, True) - If set to false bounded services won't be listed. - - alb_type (False, str, all) None + resource_group_id (False, str, None) + ID of the resource group. + + ibmcloud_api_key (True, any, None) The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'. diff --git a/docs/ibm_container_cluster_worker_info.rst b/docs/ibm_container_cluster_worker_info.rst index 56d575226..9601add45 100644 --- a/docs/ibm_container_cluster_worker_info.rst +++ b/docs/ibm_container_cluster_worker_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - resource_group_id (False, str, None) - ID of the resource group. - - worker_id (True, str, None) ID of the worker + resource_group_id (False, str, None) + ID of the resource group. + + ibmcloud_api_key (True, any, None) The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'. diff --git a/docs/ibm_container_nlb_dns.rst b/docs/ibm_container_nlb_dns.rst index 3fef6c95e..dc2d7bebf 100644 --- a/docs/ibm_container_nlb_dns.rst +++ b/docs/ibm_container_nlb_dns.rst @@ -35,10 +35,6 @@ Parameters The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the GET /v1/clusters/idOrName API. To list available resource group IDs, run ibmcloud resource groups. - cluster (True, str, None) - (Required for new resource) The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. - - nlb_host (True, str, None) (Required for new resource) @@ -47,6 +43,10 @@ Parameters (Required for new resource) + cluster (True, str, None) + (Required for new resource) The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_container_storage_attachment.rst b/docs/ibm_container_storage_attachment.rst index 999d2becf..2043ce98a 100644 --- a/docs/ibm_container_storage_attachment.rst +++ b/docs/ibm_container_storage_attachment.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - volume (True, str, None) - (Required for new resource) VPC Volume ID - - cluster (True, str, None) (Required for new resource) Cluster name or ID @@ -47,6 +43,10 @@ Parameters ID of the resource group. + volume (True, str, None) + (Required for new resource) VPC Volume ID + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_container_storage_attachment_info.rst b/docs/ibm_container_storage_attachment_info.rst index be52b7d02..cdfe7d6ce 100644 --- a/docs/ibm_container_storage_attachment_info.rst +++ b/docs/ibm_container_storage_attachment_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + cluster (True, str, None) + Cluster name or ID + + worker (True, str, None) Worker node ID @@ -41,10 +45,6 @@ Parameters The volume attachment ID - cluster (True, str, None) - Cluster name or ID - - ibmcloud_api_key (True, any, None) The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'. diff --git a/docs/ibm_container_vpc_alb.rst b/docs/ibm_container_vpc_alb.rst index 78e4d1375..bbec7696e 100644 --- a/docs/ibm_container_vpc_alb.rst +++ b/docs/ibm_container_vpc_alb.rst @@ -31,20 +31,20 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - alb_id (True, str, None) - (Required for new resource) ALB ID - - - resource_group_id (False, str, None) - ID of the resource group. + disable_deployment (False, bool, None) + Disable the ALB instance in the cluster enable (False, bool, None) Enable the ALB instance in the cluster - disable_deployment (False, bool, None) - Disable the ALB instance in the cluster + alb_id (True, str, None) + (Required for new resource) ALB ID + + + resource_group_id (False, str, None) + ID of the resource group. id (False, str, None) diff --git a/docs/ibm_container_vpc_alb_create.rst b/docs/ibm_container_vpc_alb_create.rst index 89353942a..e6f4d5555 100644 --- a/docs/ibm_container_vpc_alb_create.rst +++ b/docs/ibm_container_vpc_alb_create.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + zone (True, str, None) + (Required for new resource) The zone where you want to deploy the ALB. + + + cluster (True, str, None) + (Required for new resource) The ID of the cluster that the ALB belongs to. + + type (True, str, None) (Required for new resource) The type of ALB that you want to create. @@ -43,14 +51,6 @@ Parameters Enable the ALB instance in the cluster - zone (True, str, None) - (Required for new resource) The zone where you want to deploy the ALB. - - - cluster (True, str, None) - (Required for new resource) The ID of the cluster that the ALB belongs to. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_container_vpc_cluster.rst b/docs/ibm_container_vpc_cluster.rst index 2661472d8..b40f20868 100644 --- a/docs/ibm_container_vpc_cluster.rst +++ b/docs/ibm_container_vpc_cluster.rst @@ -31,26 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - wait_for_worker_update (False, bool, True) - Wait for worker node to update during kube version update. - - - kube_version (False, str, None) - Kubernetes version - - - disable_public_service_endpoint (False, bool, False) - Boolean value true if Public service endpoint to be disabled - - - force_delete_storage (False, bool, False) - Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered - - - service_subnet (False, str, None) - Custom subnet CIDR to provide private IP addresses for services - - worker_count (False, int, 1) Number of worker nodes in the cluster @@ -59,64 +39,84 @@ Parameters A standard cloud object storage instance CRN to back up the internal registry in your OpenShift on VPC Gen 2 cluster - flavor (True, str, None) - (Required for new resource) Cluster nodes flavour + kube_version (False, str, None) + Kubernetes version retry_patch_version (False, int, None) Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails - pod_subnet (False, str, None) - Custom subnet CIDR to provide private IP addresses for pods + worker_labels (False, dict, None) + Labels for default worker pool tags (False, list, None) List of tags for the resources - wait_till (False, str, IngressReady) - wait_till can be configured for Master Ready, One worker Ready or Ingress Ready + flavor (True, str, None) + (Required for new resource) Cluster nodes flavour kms_config (False, list, None) Enables KMS on a given cluster - zones (True, list, None) - (Required for new resource) Zone info - - name (True, str, None) (Required for new resource) The cluster name - resource_group_id (False, str, None) - ID of the resource group. + update_all_workers (False, bool, False) + Updates all the woker nodes if sets to true + + + wait_for_worker_update (False, bool, True) + Wait for worker node to update during kube version update. + + + vpc_id (True, str, None) + (Required for new resource) The vpc id where the cluster is + + + zones (True, list, None) + (Required for new resource) Zone info patch_version (False, str, None) Kubernetes patch version - worker_labels (False, dict, None) - Labels for default worker pool + service_subnet (False, str, None) + Custom subnet CIDR to provide private IP addresses for services + + + disable_public_service_endpoint (False, bool, False) + Boolean value true if Public service endpoint to be disabled + + + pod_subnet (False, str, None) + Custom subnet CIDR to provide private IP addresses for pods taints (False, list, None) WorkerPool Taints - entitlement (False, str, None) - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + wait_till (False, str, IngressReady) + wait_till can be configured for Master Ready, One worker Ready or Ingress Ready - vpc_id (True, str, None) - (Required for new resource) The vpc id where the cluster is + force_delete_storage (False, bool, False) + Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered - update_all_workers (False, bool, False) - Updates all the woker nodes if sets to true + entitlement (False, str, None) + Entitlement option reduces additional OCP Licence cost in Openshift Clusters + + + resource_group_id (False, str, None) + ID of the resource group. id (False, str, None) diff --git a/docs/ibm_container_vpc_cluster_alb_info.rst b/docs/ibm_container_vpc_cluster_alb_info.rst index 514448830..5ad6a0d72 100644 --- a/docs/ibm_container_vpc_cluster_alb_info.rst +++ b/docs/ibm_container_vpc_cluster_alb_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - resource_group_id (False, str, None) - ID of the resource group. - - alb_id (True, str, None) ALB ID + resource_group_id (False, str, None) + ID of the resource group. + + ibmcloud_api_key (True, any, None) The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'. diff --git a/docs/ibm_container_vpc_cluster_info.rst b/docs/ibm_container_vpc_cluster_info.rst index 7fb50466e..fcad31d74 100644 --- a/docs/ibm_container_vpc_cluster_info.rst +++ b/docs/ibm_container_vpc_cluster_info.rst @@ -33,14 +33,14 @@ Parameters None - name (False, str, None) - Name or id of the cluster - - resource_group_id (False, str, None) ID of the resource group. + name (False, str, None) + Name or id of the cluster + + ibmcloud_api_key (True, any, None) The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'. diff --git a/docs/ibm_container_vpc_cluster_worker_info.rst b/docs/ibm_container_vpc_cluster_worker_info.rst index 9ae43449e..fb52b9e5c 100644 --- a/docs/ibm_container_vpc_cluster_worker_info.rst +++ b/docs/ibm_container_vpc_cluster_worker_info.rst @@ -29,10 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - resource_group_id (False, str, None) - ID of the resource group. - - cluster_name_id (True, str, None) Name or ID of the cluster @@ -41,6 +37,10 @@ Parameters ID of the worker + resource_group_id (False, str, None) + ID of the resource group. + + ibmcloud_api_key (True, any, None) The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'. diff --git a/docs/ibm_container_vpc_cluster_worker_pool_info.rst b/docs/ibm_container_vpc_cluster_worker_pool_info.rst index a823a03ac..03ea265f3 100644 --- a/docs/ibm_container_vpc_cluster_worker_pool_info.rst +++ b/docs/ibm_container_vpc_cluster_worker_pool_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - cluster (True, str, None) - Cluster name - - worker_pool_name (True, str, None) worker pool name + cluster (True, str, None) + Cluster name + + ibmcloud_api_key (True, any, None) The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'. diff --git a/docs/ibm_container_vpc_worker_pool.rst b/docs/ibm_container_vpc_worker_pool.rst index cfc5f95af..5852a57b0 100644 --- a/docs/ibm_container_vpc_worker_pool.rst +++ b/docs/ibm_container_vpc_worker_pool.rst @@ -31,8 +31,16 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - worker_count (True, int, None) - (Required for new resource) The number of workers + zones (True, list, None) + (Required for new resource) Zones info + + + resource_group_id (False, str, None) + ID of the resource group. + + + entitlement (False, str, None) + Entitlement option reduces additional OCP Licence cost in Openshift Clusters cluster (True, str, None) @@ -43,32 +51,24 @@ Parameters (Required for new resource) cluster node falvor - zones (True, list, None) - (Required for new resource) Zones info + worker_pool_name (True, str, None) + (Required for new resource) worker pool name - taints (False, list, None) - WorkerPool Taints + labels (False, dict, None) + Labels - resource_group_id (False, str, None) - ID of the resource group. + taints (False, list, None) + WorkerPool Taints vpc_id (True, str, None) (Required for new resource) The vpc id where the cluster is - worker_pool_name (True, str, None) - (Required for new resource) worker pool name - - - labels (False, dict, None) - Labels - - - entitlement (False, str, None) - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + worker_count (True, int, None) + (Required for new resource) The number of workers id (False, str, None) diff --git a/docs/ibm_container_worker_pool.rst b/docs/ibm_container_worker_pool.rst index 6083f52e6..4fb420a8e 100644 --- a/docs/ibm_container_worker_pool.rst +++ b/docs/ibm_container_worker_pool.rst @@ -31,46 +31,46 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - machine_type (True, str, None) - (Required for new resource) worker nodes machine type + hardware (False, str, shared) + Hardware type worker_pool_name (True, str, None) (Required for new resource) worker pool name - taints (False, list, None) - WorkerPool Taints + size_per_zone (True, int, None) + (Required for new resource) Number of nodes per zone - resource_group_id (False, str, None) - ID of the resource group. + entitlement (False, str, None) + Entitlement option reduces additional OCP Licence cost in Openshift Clusters + + + taints (False, list, None) + WorkerPool Taints cluster (True, str, None) (Required for new resource) Cluster name - hardware (False, str, shared) - Hardware type + labels (False, dict, None) + list of labels to worker pool - size_per_zone (True, int, None) - (Required for new resource) Number of nodes per zone + resource_group_id (False, str, None) + ID of the resource group. - entitlement (False, str, None) - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + machine_type (True, str, None) + (Required for new resource) worker nodes machine type disk_encryption (False, bool, True) worker node disk encrypted if set to true - labels (False, dict, None) - list of labels to worker pool - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_container_worker_pool_info.rst b/docs/ibm_container_worker_pool_info.rst index 7edb355ca..9177396f9 100644 --- a/docs/ibm_container_worker_pool_info.rst +++ b/docs/ibm_container_worker_pool_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - cluster (True, str, None) - Name or ID of the cluster - - worker_pool_name (True, str, None) worker pool name + cluster (True, str, None) + Name or ID of the cluster + + ibmcloud_api_key (True, any, None) The IBM Cloud API key to authenticate with the IBM Cloud platform. This can also be provided via the environment variable 'IC_API_KEY'. diff --git a/docs/ibm_container_worker_pool_zone_attachment.rst b/docs/ibm_container_worker_pool_zone_attachment.rst index 48b416651..5188045ec 100644 --- a/docs/ibm_container_worker_pool_zone_attachment.rst +++ b/docs/ibm_container_worker_pool_zone_attachment.rst @@ -31,22 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - wait_till_albs (False, bool, True) - wait_till_albs can be configured to wait for albs during the worker pool zone attachment. - - - zone (True, str, None) - (Required for new resource) Zone name - - cluster (True, str, None) (Required for new resource) cluster name or ID - worker_pool (True, str, None) - (Required for new resource) Workerpool name - - private_vlan_id (False, str, None) None @@ -59,6 +47,18 @@ Parameters ID of the resource group. + wait_till_albs (False, bool, True) + wait_till_albs can be configured to wait for albs during the worker pool zone attachment. + + + zone (True, str, None) + (Required for new resource) Zone name + + + worker_pool (True, str, None) + (Required for new resource) Workerpool name + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cos_bucket.rst b/docs/ibm_cos_bucket.rst index 4da5561a0..f438c38e4 100644 --- a/docs/ibm_cos_bucket.rst +++ b/docs/ibm_cos_bucket.rst @@ -31,22 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - force_delete (False, bool, True) - COS buckets need to be empty before they can be deleted. force_delete option empty the bucket and delete it. - - - cross_region_location (False, str, None) - Cros region location info - - metrics_monitoring (False, list, None) Enables sending metrics to IBM Cloud Monitoring. - archive_rule (False, list, None) - Enable configuration archive_rule (glacier/accelerated) to COS Bucket after a defined period of time - - expire_rule (False, list, None) Enable configuration expire_rule to COS Bucket after a defined period of time @@ -55,58 +43,70 @@ Parameters Protect objects from accidental deletion or overwrites. Versioning allows you to keep multiple versions of an object protecting from unintentional data loss. - key_protect (False, str, None) - CRN of the key you want to use data at rest encryption - - - region_location (False, str, None) - Region Location info. + cross_region_location (False, str, None) + Cros region location info storage_class (True, str, None) (Required for new resource) Storage class info - retention_rule (False, list, None) - A retention policy is enabled at the IBM Cloud Object Storage bucket level. Minimum, maximum and default retention period are defined by this policy and apply to all objects in the bucket. - - - hard_quota (False, int, None) - sets a maximum amount of storage (in bytes) available for a bucket + force_delete (False, bool, True) + COS buckets need to be empty before they can be deleted. force_delete option empty the bucket and delete it. bucket_name (True, str, None) (Required for new resource) COS Bucket name - resource_instance_id (True, str, None) - (Required for new resource) resource instance ID + region_location (False, str, None) + Region Location info. - allowed_ip (False, list, None) - List of IPv4 or IPv6 addresses + activity_tracking (False, list, None) + Enables sending log data to Activity Tracker and LogDNA to provide visibility into object read and write events abort_incomplete_multipart_upload_days (False, list, None) Enable abort incomplete multipart upload to COS Bucket after a defined period of time + archive_rule (False, list, None) + Enable configuration archive_rule (glacier/accelerated) to COS Bucket after a defined period of time + + + resource_instance_id (True, str, None) + (Required for new resource) resource instance ID + + single_site_location (False, str, None) single site location info - endpoint_type (False, str, public) - public or private + allowed_ip (False, list, None) + List of IPv4 or IPv6 addresses - activity_tracking (False, list, None) - Enables sending log data to Activity Tracker and LogDNA to provide visibility into object read and write events + retention_rule (False, list, None) + A retention policy is enabled at the IBM Cloud Object Storage bucket level. Minimum, maximum and default retention period are defined by this policy and apply to all objects in the bucket. noncurrent_version_expiration (False, list, None) Enable configuration expire_rule to COS Bucket after a defined period of time + hard_quota (False, int, None) + sets a maximum amount of storage (in bytes) available for a bucket + + + key_protect (False, str, None) + CRN of the key you want to use data at rest encryption + + + endpoint_type (False, str, public) + public or private + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_cos_bucket_info.rst b/docs/ibm_cos_bucket_info.rst index a393d794d..57fd2103c 100644 --- a/docs/ibm_cos_bucket_info.rst +++ b/docs/ibm_cos_bucket_info.rst @@ -29,15 +29,11 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - bucket_type (True, str, None) + bucket_region (True, str, None) None - endpoint_type (False, str, public) - public or private - - - bucket_region (True, str, None) + resource_instance_id (True, str, None) None @@ -45,10 +41,14 @@ Parameters None - resource_instance_id (True, str, None) + bucket_type (True, str, None) None + endpoint_type (False, str, public) + public or private + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_cr_namespace.rst b/docs/ibm_cr_namespace.rst index 7792de747..1b013ed6d 100644 --- a/docs/ibm_cr_namespace.rst +++ b/docs/ibm_cr_namespace.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - tags (False, list, None) - List of tags - - name (True, str, None) (Required for new resource) The name of the namespace. @@ -43,6 +39,10 @@ Parameters The ID of the resource group that the namespace will be created within. + tags (False, list, None) + List of tags + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_database.rst b/docs/ibm_database.rst index 7be2696d2..289873efb 100644 --- a/docs/ibm_database.rst +++ b/docs/ibm_database.rst @@ -31,44 +31,40 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - configuration (False, str, None) - The configuration in JSON format - - - version (False, str, None) - The database version to provision if specified + node_count (False, int, None) + Total number of nodes in the cluster - plan_validation (False, bool, True) - For elasticsearch and postgres perform database parameter validation during the plan phase. Otherwise, database parameter validation happens in apply phase. + service_endpoints (False, str, public) + Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. - remote_leader_id (False, str, None) - The CRN of leader database + whitelist (False, list, None) + None - point_in_time_recovery_deployment_id (False, str, None) - The CRN of source instance + plan (True, str, None) + (Required for new resource) The plan type of the Database instance - point_in_time_recovery_time (False, str, None) - The point in time recovery time stamp of the deployed instance + version (False, str, None) + The database version to provision if specified members_disk_allocation_mb (False, int, None) Disk allocation required for cluster - node_count (False, int, None) - Total number of nodes in the cluster + node_cpu_allocation_count (False, int, None) + CPU allocation per node - backup_id (False, str, None) - The CRN of backup source database + point_in_time_recovery_time (False, str, None) + The point in time recovery time stamp of the deployed instance - name (True, str, None) - (Required for new resource) Resource instance name for example, my Database instance + users (False, list, None) + None resource_group_id (False, str, None) @@ -79,68 +75,72 @@ Parameters Memory allocation per node - members_memory_allocation_mb (False, int, None) - Memory allocation required for cluster + configuration (False, str, None) + The configuration in JSON format members_cpu_allocation_count (False, int, None) CPU allocation required for cluster - tags (False, list, None) - None + backup_id (False, str, None) + The CRN of backup source database + + + remote_leader_id (False, str, None) + The CRN of leader database service (True, str, None) (Required for new resource) The name of the Cloud Internet database service - plan (True, str, None) - (Required for new resource) The plan type of the Database instance + members_memory_allocation_mb (False, int, None) + Memory allocation required for cluster - adminpassword (False, str, None) - The admin user password for the instance + auto_scaling (False, list, None) + ICD Auto Scaling - key_protect_key (False, str, None) - The CRN of Key protect key + name (True, str, None) + (Required for new resource) Resource instance name for example, my Database instance - backup_encryption_key_crn (False, str, None) - The Backup Encryption Key CRN + key_protect_instance (False, str, None) + The CRN of Key protect instance - users (False, list, None) - None + backup_encryption_key_crn (False, str, None) + The Backup Encryption Key CRN - node_disk_allocation_mb (False, int, None) - Disk allocation per node + adminpassword (False, str, None) + The admin user password for the instance - node_cpu_allocation_count (False, int, None) - CPU allocation per node + point_in_time_recovery_deployment_id (False, str, None) + The CRN of source instance - service_endpoints (False, str, public) - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. + plan_validation (False, bool, True) + For elasticsearch and postgres perform database parameter validation during the plan phase. Otherwise, database parameter validation happens in apply phase. - location (True, str, None) - (Required for new resource) The location or the region in which Database instance exists + key_protect_key (False, str, None) + The CRN of Key protect key - key_protect_instance (False, str, None) - The CRN of Key protect instance + tags (False, list, None) + None - whitelist (False, list, None) - None + location (True, str, None) + (Required for new resource) The location or the region in which Database instance exists - auto_scaling (False, list, None) - ICD Auto Scaling + node_disk_allocation_mb (False, int, None) + Disk allocation per node id (False, str, None) diff --git a/docs/ibm_database_info.rst b/docs/ibm_database_info.rst index a97c9e92a..444524c40 100644 --- a/docs/ibm_database_info.rst +++ b/docs/ibm_database_info.rst @@ -29,24 +29,24 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - tags (False, list, None) - None + service (False, str, None) + The name of the Cloud Database service name (True, str, None) Resource instance name for example, my Database instance - location (False, str, None) - The location or the region in which the Database instance exists + resource_group_id (False, str, None) + The id of the resource group in which the Database instance is present - service (False, str, None) - The name of the Cloud Database service + tags (False, list, None) + None - resource_group_id (False, str, None) - The id of the resource group in which the Database instance is present + location (False, str, None) + The location or the region in which the Database instance exists iaas_classic_username (False, any, None) diff --git a/docs/ibm_dl_gateway.rst b/docs/ibm_dl_gateway.rst index a51c796ae..4425839e2 100644 --- a/docs/ibm_dl_gateway.rst +++ b/docs/ibm_dl_gateway.rst @@ -31,100 +31,100 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - loa_reject_reason (False, str, None) - Loa reject reason + bfd_status (False, str, None) + Gateway BFD status - bfd_status_updated_at (False, str, None) - Date and time BFD status was updated + bgp_ibm_cidr (False, str, None) + BGP IBM CIDR - port (False, str, None) - Gateway port + resource_group (False, str, None) + Gateway resource group - name (True, str, None) - (Required for new resource) The unique user-defined name for this gateway + authentication_key (False, str, None) + BGP MD5 authentication key - connection_mode (False, str, None) - Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection + bgp_base_cidr (False, str, None) + BGP base CIDR + + + port (False, str, None) + Gateway port metered (True, bool, None) (Required for new resource) Metered billing option - macsec_config (False, list, None) - MACsec configuration information + carrier_name (False, str, None) + Carrier name - bgp_ibm_cidr (False, str, None) - BGP IBM CIDR + global_ (True, bool, None) + (Required for new resource) Gateways with global routing (true) can connect to networks outside their associated region bfd_interval (False, int, None) BFD Interval - bfd_status (False, str, None) - Gateway BFD status - - - customer_name (False, str, None) - Customer name + speed_mbps (True, int, None) + (Required for new resource) Gateway speed in megabits per second bgp_cer_cidr (False, str, None) BGP customer edge router CIDR - bgp_asn (True, int, None) - (Required for new resource) BGP ASN - - - location_name (False, str, None) - Gateway location + loa_reject_reason (False, str, None) + Loa reject reason - authentication_key (False, str, None) - BGP MD5 authentication key + bfd_multiplier (False, int, None) + BFD Multiplier - carrier_name (False, str, None) - Carrier name + customer_name (False, str, None) + Customer name - global_ (True, bool, None) - (Required for new resource) Gateways with global routing (true) can connect to networks outside their associated region + bgp_asn (True, int, None) + (Required for new resource) BGP ASN - speed_mbps (True, int, None) - (Required for new resource) Gateway speed in megabits per second + connection_mode (False, str, None) + Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection type (True, str, None) (Required for new resource) Gateway type - resource_group (False, str, None) - Gateway resource group + name (True, str, None) + (Required for new resource) The unique user-defined name for this gateway - bfd_multiplier (False, int, None) - BFD Multiplier + macsec_config (False, list, None) + MACsec configuration information - cross_connect_router (False, str, None) - Cross connect router + tags (False, list, None) + Tags for the direct link gateway - bgp_base_cidr (False, str, None) - BGP base CIDR + bfd_status_updated_at (False, str, None) + Date and time BFD status was updated - tags (False, list, None) - Tags for the direct link gateway + cross_connect_router (False, str, None) + Cross connect router + + + location_name (False, str, None) + Gateway location id (False, str, None) diff --git a/docs/ibm_dl_provider_gateway.rst b/docs/ibm_dl_provider_gateway.rst index a3d1c1b01..010037b63 100644 --- a/docs/ibm_dl_provider_gateway.rst +++ b/docs/ibm_dl_provider_gateway.rst @@ -31,36 +31,36 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - bgp_asn (True, int, None) - (Required for new resource) BGP ASN - - port (True, str, None) (Required for new resource) Gateway port - speed_mbps (True, int, None) - (Required for new resource) Gateway speed in megabits per second + name (True, str, None) + (Required for new resource) The unique user-defined name for this gateway + + + tags (False, list, None) + Tags for the direct link gateway bgp_ibm_cidr (False, str, None) BGP IBM CIDR - bgp_cer_cidr (False, str, None) - BGP customer edge router CIDR + customer_account_id (True, str, None) + (Required for new resource) Customer IBM Cloud account ID for the new gateway. A gateway object containing the pending create request will become available in the specified account. - name (True, str, None) - (Required for new resource) The unique user-defined name for this gateway + speed_mbps (True, int, None) + (Required for new resource) Gateway speed in megabits per second - customer_account_id (True, str, None) - (Required for new resource) Customer IBM Cloud account ID for the new gateway. A gateway object containing the pending create request will become available in the specified account. + bgp_cer_cidr (False, str, None) + BGP customer edge router CIDR - tags (False, list, None) - Tags for the direct link gateway + bgp_asn (True, int, None) + (Required for new resource) BGP ASN id (False, str, None) diff --git a/docs/ibm_dl_virtual_connection.rst b/docs/ibm_dl_virtual_connection.rst index c074226e0..e36e27876 100644 --- a/docs/ibm_dl_virtual_connection.rst +++ b/docs/ibm_dl_virtual_connection.rst @@ -31,22 +31,22 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) The user-defined name for this virtual connection. Virtualconnection names are unique within a gateway. This is the name of thevirtual connection itself, the network being connected may have its ownname attribute - - gateway (True, str, None) (Required for new resource) The Direct Link gateway identifier - type (True, str, None) - (Required for new resource) The type of virtual connection.Allowable values (classic,vpc) + name (True, str, None) + (Required for new resource) The user-defined name for this virtual connection. Virtualconnection names are unique within a gateway. This is the name of thevirtual connection itself, the network being connected may have its ownname attribute network_id (False, str, None) Unique identifier of the target network. For type=vpc virtual connections this is the CRN of the target VPC. This field does not apply to type=classic connections. + type (True, str, None) + (Required for new resource) The type of virtual connection.Allowable values (classic,vpc) + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_dns_custom_resolver.rst b/docs/ibm_dns_custom_resolver.rst index e2be997c1..26d395fc5 100644 --- a/docs/ibm_dns_custom_resolver.rst +++ b/docs/ibm_dns_custom_resolver.rst @@ -31,30 +31,30 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - locations (False, list, None) - Locations on which the custom resolver will be running + name (True, str, None) + (Required for new resource) Name of the custom resolver - instance_id (True, str, None) - (Required for new resource) Instance ID + description (False, str, None) + Descriptive text of the custom resolver. - name (True, str, None) - (Required for new resource) Name of the custom resolver + instance_id (True, str, None) + (Required for new resource) Instance ID enabled (False, bool, True) Whether the custom resolver is enabled - description (False, str, None) - Descriptive text of the custom resolver. - - high_availability (False, bool, True) Whether High Availability is enabled in custom resolver + locations (False, list, None) + Locations on which the custom resolver will be running + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_dns_custom_resolver_forwarding_rule.rst b/docs/ibm_dns_custom_resolver_forwarding_rule.rst index 988080943..bc324772b 100644 --- a/docs/ibm_dns_custom_resolver_forwarding_rule.rst +++ b/docs/ibm_dns_custom_resolver_forwarding_rule.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - type (False, str, None) - Type of the forwarding rule. - - - match (False, str, None) - The matching zone or hostname. - - forward_to (False, list, None) The upstream DNS servers will be forwarded to. @@ -55,6 +47,14 @@ Parameters Descriptive text of the forwarding rule. + type (False, str, None) + Type of the forwarding rule. + + + match (False, str, None) + The matching zone or hostname. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_dns_custom_resolver_location.rst b/docs/ibm_dns_custom_resolver_location.rst index dea8a5e9d..c39b249d0 100644 --- a/docs/ibm_dns_custom_resolver_location.rst +++ b/docs/ibm_dns_custom_resolver_location.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + cr_enabled (False, bool, True) + None + + instance_id (True, str, None) (Required for new resource) Instance ID @@ -47,10 +51,6 @@ Parameters CRLocation Enabled - cr_enabled (False, bool, True) - None - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_dns_glb.rst b/docs/ibm_dns_glb.rst index ea028b261..4c418898e 100644 --- a/docs/ibm_dns_glb.rst +++ b/docs/ibm_dns_glb.rst @@ -31,8 +31,12 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - ttl (False, int, 60) - Time to live in second + description (False, str, None) + Descriptive text of the load balancer + + + fallback_pool (True, str, None) + (Required for new resource) The pool ID to use when all other pools are detected as unhealthy default_pools (True, list, None) @@ -43,28 +47,24 @@ Parameters Map availability zones to pool ID's. - fallback_pool (True, str, None) - (Required for new resource) The pool ID to use when all other pools are detected as unhealthy - - - instance_id (True, str, None) - (Required for new resource) The GUID of the private DNS. + name (True, str, None) + (Required for new resource) Name of the load balancer - zone_id (True, str, None) - (Required for new resource) Zone Id + enabled (False, bool, None) + Whether the load balancer is enabled - name (True, str, None) - (Required for new resource) Name of the load balancer + ttl (False, int, 60) + Time to live in second - description (False, str, None) - Descriptive text of the load balancer + instance_id (True, str, None) + (Required for new resource) The GUID of the private DNS. - enabled (False, bool, None) - Whether the load balancer is enabled + zone_id (True, str, None) + (Required for new resource) Zone Id id (False, str, None) diff --git a/docs/ibm_dns_glb_monitor.rst b/docs/ibm_dns_glb_monitor.rst index 268c04ec8..4f2b0eac5 100644 --- a/docs/ibm_dns_glb_monitor.rst +++ b/docs/ibm_dns_glb_monitor.rst @@ -31,28 +31,24 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - interval (False, int, 60) - The interval between each health check - - - method (False, str, None) - The method to use for the health check + name (True, str, None) + (Required for new resource) The unique identifier of a service instance. - headers (False, list, None) - The HTTP request headers to send in the health check + description (False, str, None) + Descriptive text of the load balancer monitor - expected_body (False, str, None) - A case-insensitive sub-string to look for in the response body + interval (False, int, 60) + The interval between each health check - name (True, str, None) - (Required for new resource) The unique identifier of a service instance. + retries (False, int, 1) + The number of retries to attempt in case of a timeout before marking the origin as unhealthy - description (False, str, None) - Descriptive text of the load balancer monitor + method (False, str, None) + The method to use for the health check port (False, int, None) @@ -63,16 +59,16 @@ Parameters The endpoint path to health check against - instance_id (True, str, None) - (Required for new resource) Instance Id + headers (False, list, None) + The HTTP request headers to send in the health check type (False, str, HTTP) The protocol to use for the health check - retries (False, int, 1) - The number of retries to attempt in case of a timeout before marking the origin as unhealthy + instance_id (True, str, None) + (Required for new resource) Instance Id timeout (False, int, 5) @@ -87,6 +83,10 @@ Parameters The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS + expected_body (False, str, None) + A case-insensitive sub-string to look for in the response body + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_dns_glb_pool.rst b/docs/ibm_dns_glb_pool.rst index bd8914c2e..dbe4cf5e0 100644 --- a/docs/ibm_dns_glb_pool.rst +++ b/docs/ibm_dns_glb_pool.rst @@ -31,44 +31,44 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - monitor (False, str, None) - The ID of the load balancer monitor to be associated to this pool + instance_id (True, str, None) + (Required for new resource) Instance Id - healthcheck_subnets (False, list, None) - Health check subnet crn of VSIs + healthy_origins_threshold (False, int, None) + The minimum number of origins that must be healthy for this pool to serve traffic - instance_id (True, str, None) - (Required for new resource) Instance Id + healthcheck_region (False, str, None) + Health check region of VSIs name (True, str, None) (Required for new resource) The unique identifier of a service instance. - origins (True, list, None) - (Required for new resource) Origins info + description (False, str, None) + Descriptive text of the load balancer pool - notification_channel (False, str, None) - The notification channel,It is a webhook url + healthcheck_subnets (False, list, None) + Health check subnet crn of VSIs - healthcheck_region (False, str, None) - Health check region of VSIs + monitor (False, str, None) + The ID of the load balancer monitor to be associated to this pool - description (False, str, None) - Descriptive text of the load balancer pool + notification_channel (False, str, None) + The notification channel,It is a webhook url enabled (False, bool, None) Whether the load balancer pool is enabled - healthy_origins_threshold (False, int, None) - The minimum number of origins that must be healthy for this pool to serve traffic + origins (True, list, None) + (Required for new resource) Origins info id (False, str, None) diff --git a/docs/ibm_dns_record.rst b/docs/ibm_dns_record.rst index 701dc0b32..42819a694 100644 --- a/docs/ibm_dns_record.rst +++ b/docs/ibm_dns_record.rst @@ -31,24 +31,36 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + data (True, str, None) + (Required for new resource) DNS record data + + expire (False, int, None) DNS record expiry info - mx_priority (False, int, 0) - Maximum priority + responsible_person (False, str, None) + Responsible person for DNS record - port (False, int, None) - port number + retry (False, int, None) + Retry count + + + service (False, str, None) + service info priority (False, int, 0) priority info - tags (False, list, None) - tags set for the resource + refresh (False, int, None) + refresh rate + + + ttl (True, int, None) + (Required for new resource) TTL configuration protocol (False, str, None) @@ -59,44 +71,32 @@ Parameters (Required for new resource) Domain ID of dns record instance - host (True, str, None) - (Required for new resource) Hostname - - - retry (False, int, None) - Retry count - - - ttl (True, int, None) - (Required for new resource) TTL configuration - - - type (True, str, None) - (Required for new resource) DNS record type + minimum_ttl (False, int, None) + Minimun TTL configuration - data (True, str, None) - (Required for new resource) DNS record data + port (False, int, None) + port number - responsible_person (False, str, None) - Responsible person for DNS record + weight (False, int, 0) + weight info - minimum_ttl (False, int, None) - Minimun TTL configuration + tags (False, list, None) + tags set for the resource - service (False, str, None) - service info + host (True, str, None) + (Required for new resource) Hostname - weight (False, int, 0) - weight info + mx_priority (False, int, 0) + Maximum priority - refresh (False, int, None) - refresh rate + type (True, str, None) + (Required for new resource) DNS record type id (False, str, None) diff --git a/docs/ibm_dns_resource_record.rst b/docs/ibm_dns_resource_record.rst index b8020c48b..627aba7e6 100644 --- a/docs/ibm_dns_resource_record.rst +++ b/docs/ibm_dns_resource_record.rst @@ -31,52 +31,52 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - zone_id (True, str, None) - (Required for new resource) Zone ID + ttl (False, int, 900) + DNS record TTL port (False, int, None) DNS server Port - type (True, str, None) - (Required for new resource) DNS record Type - - service (False, str, None) Service info - priority (False, int, 0) - DNS server Priority + protocol (False, str, None) + Protocol - instance_id (True, str, None) - (Required for new resource) Instance ID + name (True, str, None) + (Required for new resource) DNS record name + + + type (True, str, None) + (Required for new resource) DNS record Type preference (False, int, 0) DNS maximum preference - weight (False, int, 0) - DNS server weight + priority (False, int, 0) + DNS server Priority - protocol (False, str, None) - Protocol + rdata (True, str, None) + (Required for new resource) DNS record Data - name (True, str, None) - (Required for new resource) DNS record name + weight (False, int, 0) + DNS server weight - rdata (True, str, None) - (Required for new resource) DNS record Data + instance_id (True, str, None) + (Required for new resource) Instance ID - ttl (False, int, 900) - DNS record TTL + zone_id (True, str, None) + (Required for new resource) Zone ID id (False, str, None) diff --git a/docs/ibm_dns_secondary.rst b/docs/ibm_dns_secondary.rst index 97eb51df2..84c65a709 100644 --- a/docs/ibm_dns_secondary.rst +++ b/docs/ibm_dns_secondary.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - master_ip_address (True, str, None) - (Required for new resource) Master IP Address - - transfer_frequency (True, int, None) (Required for new resource) Transfer frequency value @@ -47,6 +43,10 @@ Parameters List of tags + master_ip_address (True, str, None) + (Required for new resource) Master IP Address + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_dns_zone.rst b/docs/ibm_dns_zone.rst index c284c4d27..e1e2e339c 100644 --- a/docs/ibm_dns_zone.rst +++ b/docs/ibm_dns_zone.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + name (True, str, None) + (Required for new resource) Zone name + + description (False, str, None) Zone description @@ -43,10 +47,6 @@ Parameters (Required for new resource) Instance ID - name (True, str, None) - (Required for new resource) Zone name - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_en_destination.rst b/docs/ibm_en_destination.rst index f2d4de205..0c9b1706e 100644 --- a/docs/ibm_en_destination.rst +++ b/docs/ibm_en_destination.rst @@ -31,16 +31,16 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - instance_guid (True, str, None) - (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. + name (True, str, None) + (Required for new resource) The Destintion name. description (False, str, None) The Destination description. - name (True, str, None) - (Required for new resource) The Destintion name. + instance_guid (True, str, None) + (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. type (True, str, None) diff --git a/docs/ibm_en_destination_info.rst b/docs/ibm_en_destination_info.rst index e8d665609..39e297416 100644 --- a/docs/ibm_en_destination_info.rst +++ b/docs/ibm_en_destination_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - destination_id (True, str, None) - Unique identifier for Destination. - - instance_guid (True, str, None) Unique identifier for IBM Cloud Event Notifications instance. + destination_id (True, str, None) + Unique identifier for Destination. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_en_subscription.rst b/docs/ibm_en_subscription.rst index a66fd607f..bb26e346c 100644 --- a/docs/ibm_en_subscription.rst +++ b/docs/ibm_en_subscription.rst @@ -31,28 +31,28 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) Subscription name. + instance_guid (True, str, None) + (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. description (False, str, None) Subscription description. - topic_id (True, str, None) - (Required for new resource) Topic ID. + destination_id (True, str, None) + (Required for new resource) Destination ID. attributes (True, list, None) (Required for new resource) - instance_guid (True, str, None) - (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. + name (True, str, None) + (Required for new resource) Subscription name. - destination_id (True, str, None) - (Required for new resource) Destination ID. + topic_id (True, str, None) + (Required for new resource) Topic ID. id (False, str, None) diff --git a/docs/ibm_en_subscription_info.rst b/docs/ibm_en_subscription_info.rst index 42ffefe2f..41808674c 100644 --- a/docs/ibm_en_subscription_info.rst +++ b/docs/ibm_en_subscription_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - subscription_id (True, str, None) - Unique identifier for result. - - instance_guid (True, str, None) Unique identifier for IBM Cloud Event Notifications instance. + subscription_id (True, str, None) + Unique identifier for result. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_en_topic.rst b/docs/ibm_en_topic.rst index 029f23518..abbb28e1d 100644 --- a/docs/ibm_en_topic.rst +++ b/docs/ibm_en_topic.rst @@ -35,6 +35,10 @@ Parameters (Required for new resource) Name of the topic. + description (False, str, None) + Description of the topic. + + sources (False, list, None) List of sources. @@ -43,10 +47,6 @@ Parameters (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. - description (False, str, None) - Description of the topic. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_en_topics_info.rst b/docs/ibm_en_topics_info.rst index 38b6e0c5a..cd9c5cccb 100644 --- a/docs/ibm_en_topics_info.rst +++ b/docs/ibm_en_topics_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - instance_guid (True, str, None) - Unique identifier for IBM Cloud Event Notifications instance. - - search_key (False, str, None) Filter the topic by name + instance_guid (True, str, None) + Unique identifier for IBM Cloud Event Notifications instance. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_enterprise.rst b/docs/ibm_enterprise.rst index 51249c129..84c502933 100644 --- a/docs/ibm_enterprise.rst +++ b/docs/ibm_enterprise.rst @@ -31,20 +31,20 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) The name of the enterprise. This field must have 3 - 60 characters. - - - domain (False, str, None) - A domain or subdomain for the enterprise, such as `example.com` or `my.example.com`. + primary_contact_iam_id (True, str, None) + (Required for new resource) The IAM ID of the enterprise primary contact, such as `IBMid-0123ABC`. The IAM ID must already exist. source_account_id (True, str, None) (Required for new resource) The ID of the account that is used to create the enterprise. - primary_contact_iam_id (True, str, None) - (Required for new resource) The IAM ID of the enterprise primary contact, such as `IBMid-0123ABC`. The IAM ID must already exist. + name (True, str, None) + (Required for new resource) The name of the enterprise. This field must have 3 - 60 characters. + + + domain (False, str, None) + A domain or subdomain for the enterprise, such as `example.com` or `my.example.com`. id (False, str, None) diff --git a/docs/ibm_enterprise_account.rst b/docs/ibm_enterprise_account.rst index 15a92c2ef..e7cf8067a 100644 --- a/docs/ibm_enterprise_account.rst +++ b/docs/ibm_enterprise_account.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - parent (True, str, None) - (Required for new resource) The CRN of the parent under which the account will be created. The parent can be an existing account group or the enterprise itself. - - owner_iam_id (False, str, None) The IAM ID of the account owner, such as `IBMid-0123ABC`. The IAM ID must already exist. @@ -43,6 +39,14 @@ Parameters The enterprise account ID. + account_id (False, str, None) + The source account id of account to be imported + + + parent (True, str, None) + (Required for new resource) The CRN of the parent under which the account will be created. The parent can be an existing account group or the enterprise itself. + + name (False, str, None) The name of the account. This field must have 3 - 60 characters. @@ -51,10 +55,6 @@ Parameters The enterprise ID that the account is a part of. - account_id (False, str, None) - The source account id of account to be imported - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_enterprise_account_group.rst b/docs/ibm_enterprise_account_group.rst index be4877f80..92cf9f006 100644 --- a/docs/ibm_enterprise_account_group.rst +++ b/docs/ibm_enterprise_account_group.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) The name of the account group. This field must have 3 - 60 characters. - - parent (True, str, None) (Required for new resource) The CRN of the parent under which the account group will be created. The parent can be an existing account group or the enterprise itself. @@ -43,6 +39,10 @@ Parameters (Required for new resource) The IAM ID of the primary contact for this account group, such as `IBMid-0123ABC`. The IAM ID must already exist. + name (True, str, None) + (Required for new resource) The name of the account group. This field must have 3 - 60 characters. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_event_streams_schema.rst b/docs/ibm_event_streams_schema.rst index ae34b934c..e8d4fca3b 100644 --- a/docs/ibm_event_streams_schema.rst +++ b/docs/ibm_event_streams_schema.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - resource_instance_id (True, str, None) - (Required for new resource) The ID or the CRN of the Event Streams service instance - - schema (True, str, None) (Required for new resource) The schema in JSON format @@ -43,6 +39,10 @@ Parameters The ID to be assigned to schema, which must be unique. If this value is not specified, a generated UUID is assigned. + resource_instance_id (True, str, None) + (Required for new resource) The ID or the CRN of the Event Streams service instance + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_event_streams_schema_info.rst b/docs/ibm_event_streams_schema_info.rst index 0936e15f4..2903055b3 100644 --- a/docs/ibm_event_streams_schema_info.rst +++ b/docs/ibm_event_streams_schema_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - resource_instance_id (True, str, None) - The ID or CRN of the Event Streams service instance - - schema_id (True, str, None) The unique ID to be assigned to the schema. + resource_instance_id (True, str, None) + The ID or CRN of the Event Streams service instance + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_event_streams_topic.rst b/docs/ibm_event_streams_topic.rst index ba85b0b16..c8592c973 100644 --- a/docs/ibm_event_streams_topic.rst +++ b/docs/ibm_event_streams_topic.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - partitions (False, int, 1) - The number of partitions - - - config (False, dict, None) - The configuration parameters of a topic - - resource_instance_id (True, str, None) (Required for new resource) The CRN of the Event Streams instance @@ -47,6 +39,14 @@ Parameters (Required for new resource) The name of the topic + partitions (False, int, 1) + The number of partitions + + + config (False, dict, None) + The configuration parameters of a topic + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_event_streams_topic_info.rst b/docs/ibm_event_streams_topic_info.rst index c1ddc3569..403a2d331 100644 --- a/docs/ibm_event_streams_topic_info.rst +++ b/docs/ibm_event_streams_topic_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - resource_instance_id (True, str, None) - The CRN of the Event Streams instance - - name (True, str, None) The name of the topic + resource_instance_id (True, str, None) + The CRN of the Event Streams instance + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_firewall.rst b/docs/ibm_firewall.rst index cb9960b76..3c39ceac5 100644 --- a/docs/ibm_firewall.rst +++ b/docs/ibm_firewall.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - public_vlan_id (True, int, None) - (Required for new resource) Public VLAN ID - - - tags (False, list, None) - List of tags for the firewall - - firewall_type (False, str, HARDWARE_FIREWALL_DEDICATED) Firewall type @@ -47,6 +39,14 @@ Parameters set to true if High availability is enabled + public_vlan_id (True, int, None) + (Required for new resource) Public VLAN ID + + + tags (False, list, None) + List of tags for the firewall + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_function_action.rst b/docs/ibm_function_action.rst index 0763dfb73..3ec07c731 100644 --- a/docs/ibm_function_action.rst +++ b/docs/ibm_function_action.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + name (True, str, None) + (Required for new resource) Name of action. + + namespace (True, str, None) (Required for new resource) IBM Cloud function namespace. @@ -43,20 +47,16 @@ Parameters Action visibilty. - user_defined_annotations (False, str, []) - Annotation values in KEY VALUE format. - - - name (True, str, None) - (Required for new resource) Name of action. + user_defined_parameters (False, str, []) + Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the action. limits (False, list, None) None - user_defined_parameters (False, str, []) - Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the action. + user_defined_annotations (False, str, []) + Annotation values in KEY VALUE format. id (False, str, None) diff --git a/docs/ibm_function_action_info.rst b/docs/ibm_function_action_info.rst index a06e130ff..2fbb2f53f 100644 --- a/docs/ibm_function_action_info.rst +++ b/docs/ibm_function_action_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - Name of action. - - namespace (True, str, None) Name of the namespace. + name (True, str, None) + Name of action. + + function_namespace (True, any, None) The namespace in IBM Cloud™ Functions where you want to create your resources. This can also be provided via the environment variable 'FUNCTION_NAMESPACE'. diff --git a/docs/ibm_function_package.rst b/docs/ibm_function_package.rst index 4f4bc9bb1..d15fe3cd6 100644 --- a/docs/ibm_function_package.rst +++ b/docs/ibm_function_package.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + namespace (True, str, None) + (Required for new resource) IBM Cloud function namespace. + + name (True, str, None) (Required for new resource) Name of package. @@ -39,22 +43,18 @@ Parameters Annotation values in KEY VALUE format. - user_defined_parameters (False, str, []) - Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the package. - - bind_package_name (False, str, None) Name of package to be binded. - namespace (True, str, None) - (Required for new resource) IBM Cloud function namespace. - - publish (False, bool, False) Package visibilty. + user_defined_parameters (False, str, []) + Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the package. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_function_rule.rst b/docs/ibm_function_rule.rst index ab5cb6535..6caf2221c 100644 --- a/docs/ibm_function_rule.rst +++ b/docs/ibm_function_rule.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - action_name (True, str, None) - (Required for new resource) Name of action. - - namespace (True, str, None) (Required for new resource) IBM Cloud function namespace. @@ -47,6 +43,10 @@ Parameters (Required for new resource) Name of trigger. + action_name (True, str, None) + (Required for new resource) Name of action. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_hardware_firewall_shared.rst b/docs/ibm_hardware_firewall_shared.rst index d60609003..a7513957c 100644 --- a/docs/ibm_hardware_firewall_shared.rst +++ b/docs/ibm_hardware_firewall_shared.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - firewall_type (True, str, None) - (Required for new resource) Firewall type - - virtual_instance_id (False, int, None) Virtual instance ID @@ -43,6 +39,10 @@ Parameters Hardware instance ID + firewall_type (True, str, None) + (Required for new resource) Firewall type + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_hpcs.rst b/docs/ibm_hpcs.rst index ea5c4c2b8..596e5c059 100644 --- a/docs/ibm_hpcs.rst +++ b/docs/ibm_hpcs.rst @@ -35,54 +35,54 @@ Parameters The number of failover crypto units for your service instance - admins (True, list, None) - (Required for new resource) Crypto Unit Administrators - - - revocation_threshold (True, int, None) - (Required for new resource) Revocation Threshold Value + service (False, str, hs-crypto) + The name of the service offering `hs-crypto` - location (True, str, None) - (Required for new resource) The location where the HPCS instance available + signature_threshold (True, int, None) + (Required for new resource) Signature Threshold Value - units (True, int, None) - (Required for new resource) The number of operational crypto units for your service instance + tags (False, list, None) + None resource_group_id (False, str, None) The resource group id - name (True, str, None) - (Required for new resource) A name for the HPCS instance - - - tags (False, list, None) - None + units (True, int, None) + (Required for new resource) The number of operational crypto units for your service instance - signature_threshold (True, int, None) - (Required for new resource) Signature Threshold Value + signature_server_url (False, str, None) + URL of signing service plan (True, str, None) (Required for new resource) The plan type of the HPCS Instance - signature_server_url (False, str, None) - URL of signing service + revocation_threshold (True, int, None) + (Required for new resource) Revocation Threshold Value - service (False, str, hs-crypto) - The name of the service offering `hs-crypto` + location (True, str, None) + (Required for new resource) The location where the HPCS instance available service_endpoints (False, str, None) Types of the service endpoints. Possible values are `public-and-private`, `private-only`. + admins (True, list, None) + (Required for new resource) Crypto Unit Administrators + + + name (True, str, None) + (Required for new resource) A name for the HPCS instance + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_hpcs_info.rst b/docs/ibm_hpcs_info.rst index bcedacc91..17fcef2e1 100644 --- a/docs/ibm_hpcs_info.rst +++ b/docs/ibm_hpcs_info.rst @@ -29,14 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - location (False, str, None) - The location or the environment in which instance exists - - - service (False, str, hs-crypto) - The service type of the instance - - name (True, str, None) Resource instance name for example, myobjectstorage @@ -45,6 +37,14 @@ Parameters The id of the resource group in which the instance is present + service (False, str, hs-crypto) + The service type of the instance + + + location (False, str, None) + The location or the environment in which instance exists + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_iam_access_group_dynamic_rule.rst b/docs/ibm_iam_access_group_dynamic_rule.rst index 78c708dfc..26ee60d50 100644 --- a/docs/ibm_iam_access_group_dynamic_rule.rst +++ b/docs/ibm_iam_access_group_dynamic_rule.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - identity_provider (True, str, None) - (Required for new resource) The realm name or identity proivider url - - - conditions (True, list, None) - (Required for new resource) conditions info - - access_group_id (True, str, None) (Required for new resource) Unique identifier of the access group @@ -51,6 +43,14 @@ Parameters (Required for new resource) The expiration in hours + identity_provider (True, str, None) + (Required for new resource) The realm name or identity proivider url + + + conditions (True, list, None) + (Required for new resource) conditions info + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_iam_api_key.rst b/docs/ibm_iam_api_key.rst index 969fc4ef0..9797fb9a5 100644 --- a/docs/ibm_iam_api_key.rst +++ b/docs/ibm_iam_api_key.rst @@ -31,28 +31,28 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key. + apikey (False, str, None) + You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing in this value. - file (False, str, None) - File where api key is to be stored + description (False, str, None) + The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key. - entity_lock (False, str, False) - Indicates if the API key is locked for further write operations. False by default. + store_value (False, bool, None) + Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing of API keys for users. - description (False, str, None) - The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key. + name (True, str, None) + (Required for new resource) Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key. - apikey (False, str, None) - You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing in this value. + file (False, str, None) + File where api key is to be stored - store_value (False, bool, None) - Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing of API keys for users. + entity_lock (False, str, False) + Indicates if the API key is locked for further write operations. False by default. id (False, str, None) diff --git a/docs/ibm_iam_authorization_policies_info.rst b/docs/ibm_iam_authorization_policies_info.rst index 8e352bf4b..bee064c90 100644 --- a/docs/ibm_iam_authorization_policies_info.rst +++ b/docs/ibm_iam_authorization_policies_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - account_id (False, str, None) - The unique ID of an account - - sort (False, str, None) Sort query for policies + account_id (False, str, None) + The unique ID of an account + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_iam_authorization_policy.rst b/docs/ibm_iam_authorization_policy.rst index 95c677a5e..2121f7305 100644 --- a/docs/ibm_iam_authorization_policy.rst +++ b/docs/ibm_iam_authorization_policy.rst @@ -35,22 +35,14 @@ Parameters Description of the Policy - roles (True, list, None) - (Required for new resource) Role names of the policy definition - - - target_resource_instance_id (False, str, None) - The target resource instance Id + source_service_name (True, str, None) + (Required for new resource) The source service name source_resource_group_id (False, str, None) The source resource group Id - source_service_account (False, str, None) - Account GUID of source service - - source_resource_type (False, str, None) Resource type of source service @@ -59,18 +51,26 @@ Parameters Resource type of target service - source_service_name (True, str, None) - (Required for new resource) The source service name + source_service_account (False, str, None) + Account GUID of source service target_service_name (True, str, None) (Required for new resource) The target service name + roles (True, list, None) + (Required for new resource) Role names of the policy definition + + source_resource_instance_id (False, str, None) The source resource instance Id + target_resource_instance_id (False, str, None) + The target resource instance Id + + target_resource_group_id (False, str, None) The target resource group Id diff --git a/docs/ibm_iam_custom_role.rst b/docs/ibm_iam_custom_role.rst index 8928745fc..986adbedb 100644 --- a/docs/ibm_iam_custom_role.rst +++ b/docs/ibm_iam_custom_role.rst @@ -31,26 +31,26 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - display_name (True, str, None) - (Required for new resource) Display Name of the Custom Role - - actions (True, list, None) (Required for new resource) The actions of the role - name (True, str, None) - (Required for new resource) The name of the custom Role - - description (False, str, None) The description of the role + name (True, str, None) + (Required for new resource) The name of the custom Role + + service (True, str, None) (Required for new resource) The Service Name + display_name (True, str, None) + (Required for new resource) Display Name of the Custom Role + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_iam_service_api_key.rst b/docs/ibm_iam_service_api_key.rst index 402f75361..d130e8094 100644 --- a/docs/ibm_iam_service_api_key.rst +++ b/docs/ibm_iam_service_api_key.rst @@ -31,32 +31,32 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - iam_service_id (True, str, None) - (Required for new resource) The service iam_id that this API key authenticates - - - apikey (False, str, None) - API key value for this API key + locked (False, bool, None) + The API key cannot be changed if set to true store_value (False, bool, None) Boolean value deciding whether API key value is retrievable in the future - file (False, str, None) - File where api key is to be stored - - name (True, str, None) (Required for new resource) Name of the Service API key + iam_service_id (True, str, None) + (Required for new resource) The service iam_id that this API key authenticates + + + apikey (False, str, None) + API key value for this API key + + description (False, str, None) description of the API key - locked (False, bool, None) - The API key cannot be changed if set to true + file (False, str, None) + File where api key is to be stored id (False, str, None) diff --git a/docs/ibm_iam_service_id.rst b/docs/ibm_iam_service_id.rst index 78db2aede..75838272e 100644 --- a/docs/ibm_iam_service_id.rst +++ b/docs/ibm_iam_service_id.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - tags (False, list, None) - None - - name (True, str, None) (Required for new resource) Name of the serviceID @@ -43,6 +39,10 @@ Parameters Description of the serviceID + tags (False, list, None) + None + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_iam_service_policy.rst b/docs/ibm_iam_service_policy.rst index e448aa5ba..73e8f0fb7 100644 --- a/docs/ibm_iam_service_policy.rst +++ b/docs/ibm_iam_service_policy.rst @@ -31,22 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - iam_id (False, str, None) - IAM ID of ServiceID - - - roles (True, list, None) - (Required for new resource) Role names of the policy definition - - - resources (False, list, None) - None - - - resource_attributes (False, list, None) - Set resource attributes. - - account_management (False, bool, False) Give access to all account management services @@ -63,6 +47,22 @@ Parameters UUID of ServiceID + iam_id (False, str, None) + IAM ID of ServiceID + + + roles (True, list, None) + (Required for new resource) Role names of the policy definition + + + resources (False, list, None) + None + + + resource_attributes (False, list, None) + Set resource attributes. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_iam_service_policy_info.rst b/docs/ibm_iam_service_policy_info.rst index d3d5a60b8..afbfc6951 100644 --- a/docs/ibm_iam_service_policy_info.rst +++ b/docs/ibm_iam_service_policy_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + sort (False, str, None) + Sort query for policies + + iam_service_id (False, str, None) UUID of ServiceID @@ -37,10 +41,6 @@ Parameters IAM ID of ServiceID - sort (False, str, None) - Sort query for policies - - iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_iam_trusted_profile.rst b/docs/ibm_iam_trusted_profile.rst index d3e1491c2..d1a68c168 100644 --- a/docs/ibm_iam_trusted_profile.rst +++ b/docs/ibm_iam_trusted_profile.rst @@ -31,14 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) Name of the trusted profile. The name is checked for uniqueness. Therefore trusted profiles with the same names can not exist in the same account. - - description (False, str, None) The optional description of the trusted profile. The 'description' property is only available if a description was provided during creation of trusted profile. + name (True, str, None) + (Required for new resource) Name of the trusted profile. The name is checked for uniqueness. Therefore trusted profiles with the same names can not exist in the same account. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_iam_trusted_profile_claim_rule.rst b/docs/ibm_iam_trusted_profile_claim_rule.rst index 4d33a5d5a..0d4872f56 100644 --- a/docs/ibm_iam_trusted_profile_claim_rule.rst +++ b/docs/ibm_iam_trusted_profile_claim_rule.rst @@ -31,32 +31,32 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - expiration (False, int, None) - Session expiration in seconds, only required if type is 'Profile-SAML'. - - - profile_id (True, str, None) - (Required for new resource) ID of the trusted profile to create a claim rule. + cr_type (False, str, None) + The compute resource type the rule applies to, required only if type is specified as 'Profile-CR'. Valid values are VSI, IKS_SA, ROKS_SA. - conditions (True, list, None) - (Required for new resource) Conditions of this claim rule. + type (True, str, None) + (Required for new resource) Type of the calim rule, either 'Profile-SAML' or 'Profile-CR'. name (False, str, None) Name of the claim rule to be created or updated. - type (True, str, None) - (Required for new resource) Type of the calim rule, either 'Profile-SAML' or 'Profile-CR'. - - realm_name (False, str, None) The realm name of the Idp this claim rule applies to. This field is required only if the type is specified as 'Profile-SAML'. - cr_type (False, str, None) - The compute resource type the rule applies to, required only if type is specified as 'Profile-CR'. Valid values are VSI, IKS_SA, ROKS_SA. + expiration (False, int, None) + Session expiration in seconds, only required if type is 'Profile-SAML'. + + + profile_id (True, str, None) + (Required for new resource) ID of the trusted profile to create a claim rule. + + + conditions (True, list, None) + (Required for new resource) Conditions of this claim rule. id (False, str, None) diff --git a/docs/ibm_iam_trusted_profile_claim_rule_info.rst b/docs/ibm_iam_trusted_profile_claim_rule_info.rst index 02bd1e3a2..7eb78757b 100644 --- a/docs/ibm_iam_trusted_profile_claim_rule_info.rst +++ b/docs/ibm_iam_trusted_profile_claim_rule_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - rule_id (True, str, None) - ID of the claim rule to get. - - profile_id (True, str, None) ID of the trusted profile. + rule_id (True, str, None) + ID of the claim rule to get. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_iam_trusted_profile_link.rst b/docs/ibm_iam_trusted_profile_link.rst index 141ba444a..06f8b7211 100644 --- a/docs/ibm_iam_trusted_profile_link.rst +++ b/docs/ibm_iam_trusted_profile_link.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + profile_id (True, str, None) + (Required for new resource) ID of the trusted profile. + + cr_type (True, str, None) (Required for new resource) The compute resource type. Valid values are VSI, IKS_SA, ROKS_SA. @@ -43,10 +47,6 @@ Parameters Optional name of the Link. - profile_id (True, str, None) - (Required for new resource) ID of the trusted profile. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_iam_trusted_profile_link_info.rst b/docs/ibm_iam_trusted_profile_link_info.rst index db40d9600..8dfed2fa3 100644 --- a/docs/ibm_iam_trusted_profile_link_info.rst +++ b/docs/ibm_iam_trusted_profile_link_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - profile_id (True, str, None) - ID of the trusted profile. - - link_id (True, str, None) ID of the link. + profile_id (True, str, None) + ID of the trusted profile. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_iam_trusted_profile_policy.rst b/docs/ibm_iam_trusted_profile_policy.rst index fd6ec48be..ae2bf0538 100644 --- a/docs/ibm_iam_trusted_profile_policy.rst +++ b/docs/ibm_iam_trusted_profile_policy.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + profile_id (False, str, None) + UUID of Trusted Profile + + + iam_id (False, str, None) + IAM ID of Trusted Profile + + roles (True, list, None) (Required for new resource) Role names of the policy definition @@ -55,14 +63,6 @@ Parameters Description of the Policy - profile_id (False, str, None) - UUID of Trusted Profile - - - iam_id (False, str, None) - IAM ID of Trusted Profile - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_ipsec_vpn.rst b/docs/ibm_ipsec_vpn.rst index fa0d3cc7a..98f70a533 100644 --- a/docs/ibm_ipsec_vpn.rst +++ b/docs/ibm_ipsec_vpn.rst @@ -31,44 +31,44 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - datacenter (True, str, None) - (Required for new resource) Datacenter name - - - phase_one (False, list, None) + remote_subnet (False, list, None) None - phase_two (False, list, None) - None + datacenter (True, str, None) + (Required for new resource) Datacenter name address_translation (False, list, None) None - preshared_key (False, str, None) - Preshared Key data + customer_peer_ip (False, str, None) + Customer Peer IP Address + + + internal_subnet_id (False, int, None) + Internal subnet ID value remote_subnet_id (False, int, None) Remote subnet ID value - service_subnet_id (False, int, None) - Service subnet ID value + phase_one (False, list, None) + None - customer_peer_ip (False, str, None) - Customer Peer IP Address + phase_two (False, list, None) + None - internal_subnet_id (False, int, None) - Internal subnet ID value + preshared_key (False, str, None) + Preshared Key data - remote_subnet (False, list, None) - None + service_subnet_id (False, int, None) + Service subnet ID value id (False, str, None) diff --git a/docs/ibm_is_dedicated_host.rst b/docs/ibm_is_dedicated_host.rst index fad75b23e..55b4e3382 100644 --- a/docs/ibm_is_dedicated_host.rst +++ b/docs/ibm_is_dedicated_host.rst @@ -31,26 +31,26 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - resource_group (False, str, None) - The unique identifier for the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. - - - name (False, str, None) - The unique user-defined name for this dedicated host. If unspecified, the name will be a hyphenated list of randomly-selected words. + profile (True, str, None) + (Required for new resource) The Globally unique name of the dedicated host profile to use for this dedicated host. host_group (True, str, None) (Required for new resource) The unique identifier of the dedicated host group for this dedicated host. - profile (True, str, None) - (Required for new resource) The Globally unique name of the dedicated host profile to use for this dedicated host. - - instance_placement_enabled (False, bool, True) If set to true, instances can be placed on this dedicated host. + name (False, str, None) + The unique user-defined name for this dedicated host. If unspecified, the name will be a hyphenated list of randomly-selected words. + + + resource_group (False, str, None) + The unique identifier for the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_dedicated_host_disk_info.rst b/docs/ibm_is_dedicated_host_disk_info.rst index 2b5dab17e..8df5ab694 100644 --- a/docs/ibm_is_dedicated_host_disk_info.rst +++ b/docs/ibm_is_dedicated_host_disk_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - dedicated_host (True, str, None) - The dedicated host identifier. - - disk (True, str, None) The dedicated host disk identifier. + dedicated_host (True, str, None) + The dedicated host identifier. + + generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_dedicated_host_group.rst b/docs/ibm_is_dedicated_host_group.rst index e912091c3..b5da2b302 100644 --- a/docs/ibm_is_dedicated_host_group.rst +++ b/docs/ibm_is_dedicated_host_group.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (False, str, None) - The unique user-defined name for this dedicated host group. If unspecified, the name will be a hyphenated list of randomly-selected words. - - class_ (True, str, None) (Required for new resource) The dedicated host profile class for hosts in this group. @@ -43,6 +39,10 @@ Parameters (Required for new resource) The dedicated host profile family for hosts in this group. + name (False, str, None) + The unique user-defined name for this dedicated host group. If unspecified, the name will be a hyphenated list of randomly-selected words. + + resource_group (False, str, None) The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. diff --git a/docs/ibm_is_dedicated_host_info.rst b/docs/ibm_is_dedicated_host_info.rst index 0466b700e..35e0209c9 100644 --- a/docs/ibm_is_dedicated_host_info.rst +++ b/docs/ibm_is_dedicated_host_info.rst @@ -29,10 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - The unique name of this dedicated host - - host_group (True, str, None) The unique identifier of the dedicated host group this dedicated host belongs to @@ -41,6 +37,10 @@ Parameters The unique identifier of the resource group this dedicated host belongs to + name (True, str, None) + The unique name of this dedicated host + + generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_floating_ip.rst b/docs/ibm_is_floating_ip.rst index 3d0a38db3..a8054ed8e 100644 --- a/docs/ibm_is_floating_ip.rst +++ b/docs/ibm_is_floating_ip.rst @@ -31,24 +31,24 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - target (False, str, None) - Target info - - - resource_group (False, str, None) - Resource group info - - name (True, str, None) (Required for new resource) Name of the floating IP + tags (False, list, None) + Floating IP tags + + zone (False, str, None) Zone name - tags (False, list, None) - Floating IP tags + target (False, str, None) + Target info + + + resource_group (False, str, None) + Resource group info id (False, str, None) diff --git a/docs/ibm_is_flow_log.rst b/docs/ibm_is_flow_log.rst index e24a3e78b..16f484c1d 100644 --- a/docs/ibm_is_flow_log.rst +++ b/docs/ibm_is_flow_log.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + storage_bucket (True, str, None) + (Required for new resource) The Cloud Object Storage bucket name where the collected flows will be logged + + tags (False, list, None) Tags for the VPC Flow logs @@ -39,10 +43,6 @@ Parameters (Required for new resource) Flow Log Collector name - storage_bucket (True, str, None) - (Required for new resource) The Cloud Object Storage bucket name where the collected flows will be logged - - target (True, str, None) (Required for new resource) The target id that the flow log collector is to collect flow logs diff --git a/docs/ibm_is_ike_policy.rst b/docs/ibm_is_ike_policy.rst index f306ff58d..da7f072f0 100644 --- a/docs/ibm_is_ike_policy.rst +++ b/docs/ibm_is_ike_policy.rst @@ -31,8 +31,12 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) IKE name + resource_group (False, str, None) + IKE resource group ID + + + key_lifetime (False, int, 28800) + IKE Key lifetime authentication_algorithm (True, str, None) @@ -43,22 +47,18 @@ Parameters (Required for new resource) Encryption alogorithm type - key_lifetime (False, int, 28800) - IKE Key lifetime - - dh_group (True, int, None) (Required for new resource) IKE DH group - resource_group (False, str, None) - IKE resource group ID - - ike_version (False, int, None) IKE version + name (True, str, None) + (Required for new resource) IKE name + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_image.rst b/docs/ibm_is_image.rst index eeec4c071..0c139a805 100644 --- a/docs/ibm_is_image.rst +++ b/docs/ibm_is_image.rst @@ -35,6 +35,10 @@ Parameters A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image + name (True, str, None) + (Required for new resource) Image name + + source_volume (False, str, None) Image volume id @@ -43,24 +47,20 @@ Parameters The resource group for this image - href (False, str, None) - Image Href value - - - name (True, str, None) - (Required for new resource) Image name - - tags (False, list, None) Tags for the image + encryption_key (False, str, None) + The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource + + operating_system (False, str, None) Image Operating system - encryption_key (False, str, None) - The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource + href (False, str, None) + Image Href value id (False, str, None) diff --git a/docs/ibm_is_image_info.rst b/docs/ibm_is_image_info.rst index 27532a59c..5be4e5a38 100644 --- a/docs/ibm_is_image_info.rst +++ b/docs/ibm_is_image_info.rst @@ -33,14 +33,14 @@ Parameters Image name - identifier (False, str, None) - Image id - - visibility (False, str, None) Whether the image is publicly visible or private to the account + identifier (False, str, None) + Image id + + generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_instance.rst b/docs/ibm_is_instance.rst index 7f7a6e510..b2b854199 100644 --- a/docs/ibm_is_instance.rst +++ b/docs/ibm_is_instance.rst @@ -31,96 +31,96 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - keys (False, list, None) - SSH key Ids for the instance + profile (False, str, None) + Profile info - image (False, str, None) - image id + dedicated_host (False, str, None) + Unique Identifier of the Dedicated Host where the instance will be placed - boot_volume (False, list, None) - None + auto_delete_volume (False, bool, None) + Auto delete volume along with instance - force_recovery_time (False, int, None) - Define timeout to force the instances to start/stop in minutes. + placement_group (False, str, None) + Unique Identifier of the Placement Group for restricting the placement of the instance - total_volume_bandwidth (False, int, None) - The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes + instance_template (False, str, None) + Id of the instance template - auto_delete_volume (False, bool, None) - Auto delete volume along with instance + tags (False, list, None) + list of tags for the instance - resource_group (False, str, None) - Instance resource group + primary_network_interface (False, list, None) + Primary Network interface info - force_action (False, bool, False) - If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action. + image (False, str, None) + image id - wait_before_delete (False, bool, True) - Enables stopping of instance before deleting and waits till deletion is complete + name (True, str, None) + (Required for new resource) Instance name - tags (False, list, None) - list of tags for the instance + boot_volume (False, list, None) + None - volumes (False, list, None) - List of volumes + vpc (False, str, None) + VPC id - placement_group (False, str, None) - Unique Identifier of the Placement Group for restricting the placement of the instance + resource_group (False, str, None) + Instance resource group - zone (False, str, None) - Zone name + dedicated_host_group (False, str, None) + Unique Identifier of the Dedicated Host Group where the instance will be placed - action (False, str, None) - Enables stopping of instance before deleting and waits till deletion is complete + total_volume_bandwidth (False, int, None) + The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes - name (True, str, None) - (Required for new resource) Instance name + wait_before_delete (False, bool, True) + Enables stopping of instance before deleting and waits till deletion is complete - dedicated_host_group (False, str, None) - Unique Identifier of the Dedicated Host Group where the instance will be placed + action (False, str, None) + Enables stopping of instance before deleting and waits till deletion is complete - user_data (False, str, None) - User data given for the instance + network_interfaces (False, list, None) + None - vpc (False, str, None) - VPC id + volumes (False, list, None) + List of volumes - profile (False, str, None) - Profile info + zone (False, str, None) + Zone name - dedicated_host (False, str, None) - Unique Identifier of the Dedicated Host where the instance will be placed + keys (False, list, None) + SSH key Ids for the instance - primary_network_interface (False, list, None) - Primary Network interface info + force_action (False, bool, False) + If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action. - network_interfaces (False, list, None) - None + user_data (False, str, None) + User data given for the instance - instance_template (False, str, None) - Id of the instance template + force_recovery_time (False, int, None) + Define timeout to force the instances to start/stop in minutes. id (False, str, None) diff --git a/docs/ibm_is_instance_group.rst b/docs/ibm_is_instance_group.rst index 6de007a3f..1b628433e 100644 --- a/docs/ibm_is_instance_group.rst +++ b/docs/ibm_is_instance_group.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + tags (False, list, None) + List of tags for instance group + + instance_template (True, str, None) (Required for new resource) instance template ID @@ -43,18 +47,10 @@ Parameters Used by the instance group when scaling up instances to supply the port for the load balancer pool member. - load_balancer (False, str, None) - load balancer ID - - load_balancer_pool (False, str, None) load balancer pool ID - tags (False, list, None) - List of tags for instance group - - resource_group (False, str, None) Resource group ID @@ -63,6 +59,10 @@ Parameters (Required for new resource) list of subnet IDs + load_balancer (False, str, None) + load balancer ID + + name (True, str, None) (Required for new resource) The user-defined name for this instance group diff --git a/docs/ibm_is_instance_group_manager.rst b/docs/ibm_is_instance_group_manager.rst index 17bb8ef75..5719b9874 100644 --- a/docs/ibm_is_instance_group_manager.rst +++ b/docs/ibm_is_instance_group_manager.rst @@ -31,36 +31,36 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - instance_group (True, str, None) - (Required for new resource) instance group ID - - - manager_type (False, str, autoscale) - The type of instance group manager. - - - aggregation_window (False, int, 90) - The time window in seconds to aggregate metrics prior to evaluation + name (False, str, None) + instance group manager name cooldown (False, int, 300) The duration of time in seconds to pause further scale actions after scaling has taken place + min_membership_count (False, int, 1) + The minimum number of members in a managed instance group + + enable_manager (False, bool, True) enable instance group manager - max_membership_count (False, int, None) - The maximum number of members in a managed instance group + instance_group (True, str, None) + (Required for new resource) instance group ID - min_membership_count (False, int, 1) - The minimum number of members in a managed instance group + manager_type (False, str, autoscale) + The type of instance group manager. - name (False, str, None) - instance group manager name + aggregation_window (False, int, 90) + The time window in seconds to aggregate metrics prior to evaluation + + + max_membership_count (False, int, None) + The maximum number of members in a managed instance group id (False, str, None) diff --git a/docs/ibm_is_instance_group_manager_action.rst b/docs/ibm_is_instance_group_manager_action.rst index 12d2c1348..89f9baa4b 100644 --- a/docs/ibm_is_instance_group_manager_action.rst +++ b/docs/ibm_is_instance_group_manager_action.rst @@ -31,16 +31,8 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - instance_group (True, str, None) - (Required for new resource) instance group ID - - - membership_count (False, int, None) - The number of members the instance group should have at the scheduled time. - - - max_membership_count (False, int, None) - The maximum number of members in a managed instance group + name (False, str, None) + instance group manager action name target_manager (False, str, None) @@ -51,22 +43,30 @@ Parameters The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min period. - name (False, str, None) - instance group manager action name + membership_count (False, int, None) + The number of members the instance group should have at the scheduled time. + + + instance_group_manager (True, str, None) + (Required for new resource) Instance group manager ID of type scheduled min_membership_count (False, int, 1) The minimum number of members in a managed instance group - instance_group_manager (True, str, None) - (Required for new resource) Instance group manager ID of type scheduled + instance_group (True, str, None) + (Required for new resource) instance group ID run_at (False, str, None) The date and time the scheduled action will run. + max_membership_count (False, int, None) + The maximum number of members in a managed instance group + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_instance_group_manager_action_info.rst b/docs/ibm_is_instance_group_manager_action_info.rst index 20700fafc..ef5575950 100644 --- a/docs/ibm_is_instance_group_manager_action_info.rst +++ b/docs/ibm_is_instance_group_manager_action_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + instance_group (True, str, None) + instance group ID + + name (True, str, None) instance group manager action name @@ -37,10 +41,6 @@ Parameters Instance group manager ID of type scheduled - instance_group (True, str, None) - instance group ID - - generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_instance_group_manager_actions_info.rst b/docs/ibm_is_instance_group_manager_actions_info.rst index 38f5bc0e9..79bd13182 100644 --- a/docs/ibm_is_instance_group_manager_actions_info.rst +++ b/docs/ibm_is_instance_group_manager_actions_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - instance_group (True, str, None) - instance group ID - - instance_group_manager (True, str, None) Instance group manager ID + instance_group (True, str, None) + instance group ID + + generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_instance_group_manager_policy.rst b/docs/ibm_is_instance_group_manager_policy.rst index 64a59eb2f..52a2f08b2 100644 --- a/docs/ibm_is_instance_group_manager_policy.rst +++ b/docs/ibm_is_instance_group_manager_policy.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + policy_type (True, str, None) + (Required for new resource) The type of Policy for the Instance Group + + name (False, str, None) instance group manager policy name @@ -51,10 +55,6 @@ Parameters (Required for new resource) The metric value to be evaluated - policy_type (True, str, None) - (Required for new resource) The type of Policy for the Instance Group - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_instance_group_membership.rst b/docs/ibm_is_instance_group_membership.rst index 7d4b0d352..4768b5fb6 100644 --- a/docs/ibm_is_instance_group_membership.rst +++ b/docs/ibm_is_instance_group_membership.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - instance_group (True, str, None) - (Required for new resource) The instance group identifier. - - name (False, str, None) The user-defined name for this instance group membership. Names must be unique within the instance group. @@ -43,6 +39,10 @@ Parameters The delete flag for this instance group membership. Must be set to true to delete instance group membership. + instance_group (True, str, None) + (Required for new resource) The instance group identifier. + + instance_group_membership (True, str, None) (Required for new resource) The unique identifier for this instance group membership. diff --git a/docs/ibm_is_instance_info.rst b/docs/ibm_is_instance_info.rst index 8fb3ba64b..c8d02dbf2 100644 --- a/docs/ibm_is_instance_info.rst +++ b/docs/ibm_is_instance_info.rst @@ -29,16 +29,16 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - private_key (False, str, None) - Instance Private Key file + passphrase (False, str, None) + Passphrase for Instance Private Key file name (True, str, None) Instance name - passphrase (False, str, None) - Passphrase for Instance Private Key file + private_key (False, str, None) + Instance Private Key file generation (False, int, 2) diff --git a/docs/ibm_is_instance_network_interface.rst b/docs/ibm_is_instance_network_interface.rst index 77742cdae..dc2470bb1 100644 --- a/docs/ibm_is_instance_network_interface.rst +++ b/docs/ibm_is_instance_network_interface.rst @@ -31,30 +31,30 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - primary_ipv4_address (False, str, None) - The primary IPv4 address. If specified, it must be an available address on the network interface's subnet. If unspecified, an available address on the subnet will be automatically selected. - - - subnet (True, str, None) - (Required for new resource) The unique identifier of the subnet. + floating_ip (False, str, None) + The ID of the floating IP to attach to this network interface allow_ip_spoofing (False, bool, False) Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface. - name (True, str, None) - (Required for new resource) The user-defined name for this network interface. If unspecified, the name will be a hyphenated list of randomly-selected words. - - - floating_ip (False, str, None) - The ID of the floating IP to attach to this network interface + primary_ipv4_address (False, str, None) + The primary IPv4 address. If specified, it must be an available address on the network interface's subnet. If unspecified, an available address on the subnet will be automatically selected. instance (True, str, None) (Required for new resource) The unique identifier of the instance. + name (True, str, None) + (Required for new resource) The user-defined name for this network interface. If unspecified, the name will be a hyphenated list of randomly-selected words. + + + subnet (True, str, None) + (Required for new resource) The unique identifier of the subnet. + + security_groups (False, list, None) None diff --git a/docs/ibm_is_instance_network_interface_info.rst b/docs/ibm_is_instance_network_interface_info.rst index 49038f312..d3443ff5c 100644 --- a/docs/ibm_is_instance_network_interface_info.rst +++ b/docs/ibm_is_instance_network_interface_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - network_interface_name (True, str, None) - The network interface name. - - instance_name (True, str, None) The instance name. + network_interface_name (True, str, None) + The network interface name. + + generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_instance_template.rst b/docs/ibm_is_instance_template.rst index 96fff27d5..66df20055 100644 --- a/docs/ibm_is_instance_template.rst +++ b/docs/ibm_is_instance_template.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - profile (True, str, None) - (Required for new resource) Profile info - - dedicated_host_group (False, str, None) Unique Identifier of the Dedicated Host Group where the instance will be placed @@ -43,56 +39,60 @@ Parameters Unique Identifier of the Placement Group for restricting the placement of the instance - volume_attachments (False, list, None) + boot_volume (False, list, None) None - network_interfaces (False, list, None) - None + name (False, str, None) + Instance Template name - boot_volume (False, list, None) - None + zone (True, str, None) + (Required for new resource) Zone name - vpc (True, str, None) - (Required for new resource) VPC id + total_volume_bandwidth (False, int, None) + The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes keys (True, list, None) (Required for new resource) SSH key Ids for the instance template - dedicated_host (False, str, None) - Unique Identifier of the Dedicated Host where the instance will be placed + user_data (False, str, None) + User data given for the instance - primary_network_interface (True, list, None) - (Required for new resource) Primary Network interface info + resource_group (False, str, None) + Instance template resource group - total_volume_bandwidth (False, int, None) - The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes + image (True, str, None) + (Required for new resource) image name - zone (True, str, None) - (Required for new resource) Zone name + vpc (True, str, None) + (Required for new resource) VPC id - name (False, str, None) - Instance Template name + profile (True, str, None) + (Required for new resource) Profile info - image (True, str, None) - (Required for new resource) image name + primary_network_interface (True, list, None) + (Required for new resource) Primary Network interface info - resource_group (False, str, None) - Instance template resource group + dedicated_host (False, str, None) + Unique Identifier of the Dedicated Host where the instance will be placed - user_data (False, str, None) - User data given for the instance + volume_attachments (False, list, None) + None + + + network_interfaces (False, list, None) + None id (False, str, None) diff --git a/docs/ibm_is_instance_template_info.rst b/docs/ibm_is_instance_template_info.rst index e9430966b..20e8e4f3f 100644 --- a/docs/ibm_is_instance_template_info.rst +++ b/docs/ibm_is_instance_template_info.rst @@ -29,11 +29,11 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (False, str, None) + identifier (False, str, None) None - identifier (False, str, None) + name (False, str, None) None diff --git a/docs/ibm_is_instance_volume_attachment.rst b/docs/ibm_is_instance_volume_attachment.rst index ead1d4ea4..f371ed026 100644 --- a/docs/ibm_is_instance_volume_attachment.rst +++ b/docs/ibm_is_instance_volume_attachment.rst @@ -31,14 +31,18 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - instance (True, str, None) - (Required for new resource) Instance id - - name (False, str, None) The user-defined name for this volume attachment. + iops (False, int, None) + The maximum I/O operations per second (IOPS) for the volume. + + + instance (True, str, None) + (Required for new resource) Instance id + + volume (False, str, None) Instance id @@ -47,32 +51,28 @@ Parameters The unique user-defined name for this volume - encryption_key (False, str, None) - The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource. - - - iops (False, int, None) - The maximum I/O operations per second (IOPS) for the volume. + profile (False, str, None) + The globally unique name for the volume profile to use for this volume. - delete_volume_on_instance_delete (False, bool, None) - If set to true, when deleting the instance the volume will also be deleted. + snapshot (False, str, None) + The snapshot of the volume to be attached delete_volume_on_attachment_delete (False, bool, True) If set to true, when deleting the attachment, the volume will also be deleted. Default value for this true. - snapshot (False, str, None) - The snapshot of the volume to be attached + capacity (False, int, None) + The capacity of the volume in gigabytes. The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. - profile (False, str, None) - The globally unique name for the volume profile to use for this volume. + delete_volume_on_instance_delete (False, bool, None) + If set to true, when deleting the instance the volume will also be deleted. - capacity (False, int, None) - The capacity of the volume in gigabytes. The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. + encryption_key (False, str, None) + The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource. id (False, str, None) diff --git a/docs/ibm_is_instance_volume_attachment_info.rst b/docs/ibm_is_instance_volume_attachment_info.rst index 656e38bdf..9316ffb38 100644 --- a/docs/ibm_is_instance_volume_attachment_info.rst +++ b/docs/ibm_is_instance_volume_attachment_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - instance (True, str, None) - Instance id - - name (True, str, None) The user-defined name for this volume attachment. + instance (True, str, None) + Instance id + + generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_instances_info.rst b/docs/ibm_is_instances_info.rst index 423645d92..9d37bbc09 100644 --- a/docs/ibm_is_instances_info.rst +++ b/docs/ibm_is_instances_info.rst @@ -29,22 +29,30 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - vpc_name (False, str, None) - Name of the vpc to filter the instances attached to it - - vpc (False, str, None) VPC ID to filter the instances attached to it + placement_group (False, str, None) + ID of the placement group to filter the instances attached to it + + vpc_crn (False, str, None) VPC CRN to filter the instances attached to it + resource_group (False, str, None) + Instance resource group + + dedicated_host_name (False, str, None) Name of the dedicated host to filter the instances attached to it + dedicated_host (False, str, None) + ID of the dedicated host to filter the instances attached to it + + placement_group_name (False, str, None) Name of the placement group to filter the instances attached to it @@ -57,16 +65,8 @@ Parameters Instance group name to filter the instances attached to it - resource_group (False, str, None) - Instance resource group - - - dedicated_host (False, str, None) - ID of the dedicated host to filter the instances attached to it - - - placement_group (False, str, None) - ID of the placement group to filter the instances attached to it + vpc_name (False, str, None) + Name of the vpc to filter the instances attached to it generation (False, int, 2) diff --git a/docs/ibm_is_ipsec_policy.rst b/docs/ibm_is_ipsec_policy.rst index 2b91dcc0a..d84dc5d3e 100644 --- a/docs/ibm_is_ipsec_policy.rst +++ b/docs/ibm_is_ipsec_policy.rst @@ -31,12 +31,8 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) IPSEC name - - - authentication_algorithm (True, str, None) - (Required for new resource) Authentication alorothm + encryption_algorithm (True, str, None) + (Required for new resource) Encryption algorithm pfs (True, str, None) @@ -51,8 +47,12 @@ Parameters IPSEC key lifetime - encryption_algorithm (True, str, None) - (Required for new resource) Encryption algorithm + name (True, str, None) + (Required for new resource) IPSEC name + + + authentication_algorithm (True, str, None) + (Required for new resource) Authentication alorothm id (False, str, None) diff --git a/docs/ibm_is_lb.rst b/docs/ibm_is_lb.rst index 83c4de921..2f432f78e 100644 --- a/docs/ibm_is_lb.rst +++ b/docs/ibm_is_lb.rst @@ -39,32 +39,32 @@ Parameters None - subnets (True, list, None) - (Required for new resource) Load Balancer subnets list + route_mode (False, bool, False) + Indicates whether route mode is enabled for this load balancer - type (False, str, public) - Load Balancer type + subnets (True, list, None) + (Required for new resource) Load Balancer subnets list tags (False, list, None) None - route_mode (False, bool, False) - Indicates whether route mode is enabled for this load balancer + profile (False, str, None) + The profile to use for this load balancer. logging (False, bool, False) Logging of Load Balancer - security_groups (False, list, None) - Load Balancer securitygroups list + type (False, str, public) + Load Balancer type - profile (False, str, None) - The profile to use for this load balancer. + security_groups (False, list, None) + Load Balancer securitygroups list id (False, str, None) diff --git a/docs/ibm_is_lb_listener.rst b/docs/ibm_is_lb_listener.rst index cccfc37b8..4afb70b0e 100644 --- a/docs/ibm_is_lb_listener.rst +++ b/docs/ibm_is_lb_listener.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + default_pool (False, str, None) + Loadbalancer default pool info + + + certificate_instance (False, str, None) + certificate instance for the Loadbalancer + + accept_proxy_protocol (False, bool, None) Listener will forward proxy protocol @@ -39,12 +47,8 @@ Parameters The HTTP status code to be returned in the redirect response - https_redirect_uri (False, str, None) - Target URI where traffic will be redirected - - - https_redirect_listener (False, str, None) - ID of the listener that will be set as http redirect target + lb (True, str, None) + (Required for new resource) Loadbalancer listener ID port (False, int, None) @@ -55,22 +59,18 @@ Parameters (Required for new resource) Loadbalancer protocol - default_pool (False, str, None) - Loadbalancer default pool info + https_redirect_listener (False, str, None) + ID of the listener that will be set as http redirect target - certificate_instance (False, str, None) - certificate instance for the Loadbalancer + https_redirect_uri (False, str, None) + Target URI where traffic will be redirected connection_limit (False, int, None) Connection limit for Loadbalancer - lb (True, str, None) - (Required for new resource) Loadbalancer listener ID - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_lb_listener_policy.rst b/docs/ibm_is_lb_listener_policy.rst index f91ac7010..7bcd1923f 100644 --- a/docs/ibm_is_lb_listener_policy.rst +++ b/docs/ibm_is_lb_listener_policy.rst @@ -31,52 +31,52 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - lb (True, str, None) - (Required for new resource) Load Balancer Listener Policy - - - target_https_redirect_status_code (False, int, None) - The HTTP status code to be returned in the redirect response + name (False, str, None) + Policy name - target_https_redirect_listener (False, str, None) - ID of the listener that will be set as http redirect target + target_http_status_code (False, int, None) + Listener Policy target HTTPS Status code. - target_id (False, str, None) - Listener Policy Target ID + lb (True, str, None) + (Required for new resource) Load Balancer Listener Policy listener (True, str, None) (Required for new resource) Listener ID - target_https_redirect_uri (False, str, None) - Target URI where traffic will be redirected - - priority (True, int, None) (Required for new resource) Listener Policy Priority + rules (False, list, None) + Policy Rules + + target_url (False, str, None) Policy Target URL - name (False, str, None) - Policy name + target_id (False, str, None) + Listener Policy Target ID - action (True, str, None) - (Required for new resource) Policy Action + target_https_redirect_status_code (False, int, None) + The HTTP status code to be returned in the redirect response - rules (False, list, None) - Policy Rules + target_https_redirect_uri (False, str, None) + Target URI where traffic will be redirected - target_http_status_code (False, int, None) - Listener Policy target HTTPS Status code. + target_https_redirect_listener (False, str, None) + ID of the listener that will be set as http redirect target + + + action (True, str, None) + (Required for new resource) Policy Action id (False, str, None) diff --git a/docs/ibm_is_lb_listener_policy_rule.rst b/docs/ibm_is_lb_listener_policy_rule.rst index 57fee579f..4461666b3 100644 --- a/docs/ibm_is_lb_listener_policy_rule.rst +++ b/docs/ibm_is_lb_listener_policy_rule.rst @@ -31,34 +31,34 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - lb (True, str, None) - (Required for new resource) Loadbalancer ID - - - listener (True, str, None) - (Required for new resource) Listener ID. - - - condition (True, str, None) - (Required for new resource) Condition info of the rule. - - type (True, str, None) (Required for new resource) Policy rule type. + value (True, str, None) + (Required for new resource) policy rule value info + + policy (True, str, None) (Required for new resource) Listener Policy ID - value (True, str, None) - (Required for new resource) policy rule value info + condition (True, str, None) + (Required for new resource) Condition info of the rule. field (False, str, None) None + lb (True, str, None) + (Required for new resource) Loadbalancer ID + + + listener (True, str, None) + (Required for new resource) Listener ID. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_lb_pool.rst b/docs/ibm_is_lb_pool.rst index a322a6ae0..38f55e0b7 100644 --- a/docs/ibm_is_lb_pool.rst +++ b/docs/ibm_is_lb_pool.rst @@ -31,14 +31,30 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + session_persistence_type (False, str, None) + Load Balancer Pool session persisence type. + + + lb (True, str, None) + (Required for new resource) Load Balancer ID + + algorithm (True, str, None) (Required for new resource) Load Balancer Pool algorithm + health_retries (True, int, None) + (Required for new resource) Load Balancer health retry count + + health_type (True, str, None) (Required for new resource) Load Balancer health type + name (True, str, None) + (Required for new resource) Load Balancer Pool name + + health_monitor_port (False, int, None) Health monitor Port the LB Pool @@ -47,12 +63,8 @@ Parameters Load Balancer Pool session persisence app cookie name. - name (True, str, None) - (Required for new resource) Load Balancer Pool name - - - lb (True, str, None) - (Required for new resource) Load Balancer ID + protocol (True, str, None) + (Required for new resource) Load Balancer Protocol health_timeout (True, int, None) @@ -63,24 +75,12 @@ Parameters Health monitor URL of LB Pool - session_persistence_type (False, str, None) - Load Balancer Pool session persisence type. - - - proxy_protocol (False, str, None) - PROXY protocol setting for this pool - - - protocol (True, str, None) - (Required for new resource) Load Balancer Protocol - - health_delay (True, int, None) (Required for new resource) Load Blancer health delay time period - health_retries (True, int, None) - (Required for new resource) Load Balancer health retry count + proxy_protocol (False, str, None) + PROXY protocol setting for this pool id (False, str, None) diff --git a/docs/ibm_is_lb_pool_member.rst b/docs/ibm_is_lb_pool_member.rst index 2122eba90..58603d623 100644 --- a/docs/ibm_is_lb_pool_member.rst +++ b/docs/ibm_is_lb_pool_member.rst @@ -31,28 +31,28 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - lb (True, str, None) - (Required for new resource) Load balancer ID + pool (True, str, None) + (Required for new resource) Loadblancer Poold ID - target_id (False, str, None) - Load balancer pool member target id + lb (True, str, None) + (Required for new resource) Load balancer ID - weight (False, int, None) - Load balcner pool member weight + target_address (False, str, None) + Load balancer pool member target address - pool (True, str, None) - (Required for new resource) Loadblancer Poold ID + target_id (False, str, None) + Load balancer pool member target id port (True, int, None) (Required for new resource) Load Balancer Pool port - target_address (False, str, None) - Load balancer pool member target address + weight (False, int, None) + Load balcner pool member weight id (False, str, None) diff --git a/docs/ibm_is_network_acl.rst b/docs/ibm_is_network_acl.rst index ec7c4df7d..6e531f667 100644 --- a/docs/ibm_is_network_acl.rst +++ b/docs/ibm_is_network_acl.rst @@ -31,24 +31,24 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - vpc (False, str, None) - Network ACL VPC name + name (True, str, None) + (Required for new resource) Network ACL name - resource_group (False, str, None) - Resource group ID for the network ACL + tags (False, list, None) + List of tags rules (False, list, None) None - name (True, str, None) - (Required for new resource) Network ACL name + vpc (False, str, None) + Network ACL VPC name - tags (False, list, None) - List of tags + resource_group (False, str, None) + Resource group ID for the network ACL id (False, str, None) diff --git a/docs/ibm_is_network_acl_info.rst b/docs/ibm_is_network_acl_info.rst index 0fece09c3..391c9bc36 100644 --- a/docs/ibm_is_network_acl_info.rst +++ b/docs/ibm_is_network_acl_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (False, str, None) - The network acl name. - - vpc_name (False, str, None) The name of the vpc the network acl resides in. + name (False, str, None) + The network acl name. + + network_acl (False, str, None) The network acl id. diff --git a/docs/ibm_is_network_acl_rule.rst b/docs/ibm_is_network_acl_rule.rst index c7fab18d7..65ee702d0 100644 --- a/docs/ibm_is_network_acl_rule.rst +++ b/docs/ibm_is_network_acl_rule.rst @@ -31,16 +31,8 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - before (False, str, None) - The rule that this rule is immediately before. If absent, this is the last rule. - - - action (True, str, None) - (Required for new resource) Whether to allow or deny matching traffic - - - destination (True, str, None) - (Required for new resource) The destination CIDR block. The CIDR block 0.0.0.0/0 applies to all addresses. + udp (False, list, None) + None direction (True, str, None) @@ -51,20 +43,28 @@ Parameters None + network_acl (True, str, None) + (Required for new resource) Network ACL id + + + name (False, str, None) + The user-defined name for this rule. Names must be unique within the network ACL the rule resides in. If unspecified, the name will be a hyphenated list of randomly-selected words. + + tcp (False, list, None) None - udp (False, list, None) - None + destination (True, str, None) + (Required for new resource) The destination CIDR block. The CIDR block 0.0.0.0/0 applies to all addresses. - network_acl (True, str, None) - (Required for new resource) Network ACL id + before (False, str, None) + The rule that this rule is immediately before. If absent, this is the last rule. - name (False, str, None) - The user-defined name for this rule. Names must be unique within the network ACL the rule resides in. If unspecified, the name will be a hyphenated list of randomly-selected words. + action (True, str, None) + (Required for new resource) Whether to allow or deny matching traffic source (True, str, None) diff --git a/docs/ibm_is_public_gateway.rst b/docs/ibm_is_public_gateway.rst index 2fd9f2705..2742c5bf8 100644 --- a/docs/ibm_is_public_gateway.rst +++ b/docs/ibm_is_public_gateway.rst @@ -31,30 +31,30 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - floating_ip (False, dict, None) - None - - - vpc (True, str, None) - (Required for new resource) Public gateway VPC info - - - tags (False, list, None) - Service tags for the public gateway instance + resource_group (False, str, None) + Public gateway resource group info name (True, str, None) (Required for new resource) Name of the Public gateway instance - resource_group (False, str, None) - Public gateway resource group info + floating_ip (False, dict, None) + None zone (True, str, None) (Required for new resource) Public gateway zone info + tags (False, list, None) + Service tags for the public gateway instance + + + vpc (True, str, None) + (Required for new resource) Public gateway VPC info + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_security_group.rst b/docs/ibm_is_security_group.rst index 89585b5ae..2c3887693 100644 --- a/docs/ibm_is_security_group.rst +++ b/docs/ibm_is_security_group.rst @@ -31,22 +31,22 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - vpc (True, str, None) - (Required for new resource) Security group's resource group id + name (False, str, None) + Security group name tags (False, list, None) List of tags - name (False, str, None) - Security group name - - resource_group (False, str, None) Resource Group ID + vpc (True, str, None) + (Required for new resource) Security group's resource group id + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_security_group_target_info.rst b/docs/ibm_is_security_group_target_info.rst index b982a1930..041402ba8 100644 --- a/docs/ibm_is_security_group_target_info.rst +++ b/docs/ibm_is_security_group_target_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - security_group (True, str, None) - Security group id - - name (True, str, None) Security group target name + security_group (True, str, None) + Security group id + + generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_snapshot.rst b/docs/ibm_is_snapshot.rst index 59e70827e..333696a48 100644 --- a/docs/ibm_is_snapshot.rst +++ b/docs/ibm_is_snapshot.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + source_volume (True, str, None) + (Required for new resource) Snapshot source volume + + name (False, str, None) Snapshot name @@ -39,10 +43,6 @@ Parameters Resource group info - source_volume (True, str, None) - (Required for new resource) Snapshot source volume - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_ssh_key.rst b/docs/ibm_is_ssh_key.rst index 2ffba0aa9..e6176f334 100644 --- a/docs/ibm_is_ssh_key.rst +++ b/docs/ibm_is_ssh_key.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - tags (False, list, None) - List of tags for SSH key - - - public_key (True, str, None) - (Required for new resource) SSH Public key data - - resource_group (False, str, None) Resource group ID @@ -47,6 +39,14 @@ Parameters (Required for new resource) SSH Key name + tags (False, list, None) + List of tags for SSH key + + + public_key (True, str, None) + (Required for new resource) SSH Public key data + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_subnet.rst b/docs/ibm_is_subnet.rst index 136b3dd33..5d5fecdbd 100644 --- a/docs/ibm_is_subnet.rst +++ b/docs/ibm_is_subnet.rst @@ -31,24 +31,16 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - ipv4_cidr_block (False, str, None) - IPV4 subnet - CIDR block - - - name (True, str, None) - (Required for new resource) Subnet name - - network_acl (False, str, None) The network ACL for this subnet - zone (True, str, None) - (Required for new resource) Subnet zone info + tags (False, list, None) + List of tags - routing_table (False, str, None) - routing table id that is associated with the subnet + public_gateway (False, str, None) + Public Gateway of the subnet total_ipv4_address_count (False, int, None) @@ -59,26 +51,34 @@ Parameters The IP version(s) to support for this subnet. - tags (False, list, None) - List of tags + access_tags (False, list, None) + List of access management tags - public_gateway (False, str, None) - Public Gateway of the subnet + routing_table (False, str, None) + routing table id that is associated with the subnet - vpc (True, str, None) - (Required for new resource) VPC instance ID + ipv4_cidr_block (False, str, None) + IPV4 subnet - CIDR block - access_tags (False, list, None) - List of access management tags + vpc (True, str, None) + (Required for new resource) VPC instance ID resource_group (False, str, None) The resource group for this subnet + name (True, str, None) + (Required for new resource) Subnet name + + + zone (True, str, None) + (Required for new resource) Subnet zone info + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_subnet_info.rst b/docs/ibm_is_subnet_info.rst index b30421259..c8f8ae3bf 100644 --- a/docs/ibm_is_subnet_info.rst +++ b/docs/ibm_is_subnet_info.rst @@ -29,11 +29,11 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (False, str, None) + identifier (False, str, None) None - identifier (False, str, None) + name (False, str, None) None diff --git a/docs/ibm_is_subnet_reserved_ip.rst b/docs/ibm_is_subnet_reserved_ip.rst index 95ffd581e..03ae4af5b 100644 --- a/docs/ibm_is_subnet_reserved_ip.rst +++ b/docs/ibm_is_subnet_reserved_ip.rst @@ -35,14 +35,14 @@ Parameters (Required for new resource) The subnet identifier. - auto_delete (False, bool, None) - If set to true, this reserved IP will be automatically deleted - - target (False, str, None) The unique identifier for target. + auto_delete (False, bool, None) + If set to true, this reserved IP will be automatically deleted + + name (False, str, None) The user-defined or system-provided name for this reserved IP. diff --git a/docs/ibm_is_virtual_endpoint_gateway.rst b/docs/ibm_is_virtual_endpoint_gateway.rst index bd268e979..769a3b73d 100644 --- a/docs/ibm_is_virtual_endpoint_gateway.rst +++ b/docs/ibm_is_virtual_endpoint_gateway.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - vpc (True, str, None) - (Required for new resource) The VPC id - - - ips (False, list, None) - Endpoint gateway IPs - - target (True, list, None) (Required for new resource) Endpoint gateway target @@ -59,6 +51,14 @@ Parameters Endpoint gateway securitygroups list + ips (False, list, None) + Endpoint gateway IPs + + + vpc (True, str, None) + (Required for new resource) The VPC id + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_volume.rst b/docs/ibm_is_volume.rst index ebcf1323b..27a87c8ff 100644 --- a/docs/ibm_is_volume.rst +++ b/docs/ibm_is_volume.rst @@ -31,40 +31,40 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - delete_all_snapshots (False, bool, None) - Deletes all snapshots created from this volume - - profile (True, str, None) (Required for new resource) Volume profile name - encryption_key (False, str, None) - Volume encryption key info + zone (True, str, None) + (Required for new resource) Zone name - iops (False, int, None) - IOPS value for the Volume + tags (False, list, None) + Tags for the volume instance - name (True, str, None) - (Required for new resource) Volume name + capacity (False, int, 100) + Volume capacity value - zone (True, str, None) - (Required for new resource) Zone name + delete_all_snapshots (False, bool, None) + Deletes all snapshots created from this volume - capacity (False, int, 100) - Volume capacity value + encryption_key (False, str, None) + Volume encryption key info + + + name (True, str, None) + (Required for new resource) Volume name resource_group (False, str, None) Resource group name - tags (False, list, None) - Tags for the volume instance + iops (False, int, None) + IOPS value for the Volume id (False, str, None) diff --git a/docs/ibm_is_volume_info.rst b/docs/ibm_is_volume_info.rst index 8c331be8d..11f01b9c3 100644 --- a/docs/ibm_is_volume_info.rst +++ b/docs/ibm_is_volume_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - zone (False, str, None) - Zone name - - name (True, str, None) Volume name + zone (False, str, None) + Zone name + + generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_vpc.rst b/docs/ibm_is_vpc.rst index c800ca0a1..122e33f38 100644 --- a/docs/ibm_is_vpc.rst +++ b/docs/ibm_is_vpc.rst @@ -31,36 +31,36 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - address_prefix_management (False, str, auto) - Address Prefix management value + resource_group (False, str, None) + Resource group info - default_network_acl_name (False, str, None) - Default Network ACL name + address_prefix_management (False, str, auto) + Address Prefix management value - default_security_group_name (False, str, None) - Default security group name + classic_access (False, bool, False) + Set to true if classic access needs to enabled to VPC - default_routing_table_name (False, str, None) - Default routing table name + default_network_acl_name (False, str, None) + Default Network ACL name - classic_access (False, bool, False) - Set to true if classic access needs to enabled to VPC + tags (False, list, None) + List of tags name (True, str, None) (Required for new resource) VPC name - resource_group (False, str, None) - Resource group info + default_security_group_name (False, str, None) + Default security group name - tags (False, list, None) - List of tags + default_routing_table_name (False, str, None) + Default routing table name id (False, str, None) diff --git a/docs/ibm_is_vpc_address_prefix.rst b/docs/ibm_is_vpc_address_prefix.rst index 9ab6bf14a..43b3f8b16 100644 --- a/docs/ibm_is_vpc_address_prefix.rst +++ b/docs/ibm_is_vpc_address_prefix.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) Name - - - zone (True, str, None) - (Required for new resource) Zone name - - cidr (True, str, None) (Required for new resource) CIDIR address prefix @@ -51,6 +43,14 @@ Parameters (Required for new resource) VPC id + name (True, str, None) + (Required for new resource) Name + + + zone (True, str, None) + (Required for new resource) Zone name + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_vpc_address_prefixes_info.rst b/docs/ibm_is_vpc_address_prefixes_info.rst index 4cc91d37d..e43264985 100644 --- a/docs/ibm_is_vpc_address_prefixes_info.rst +++ b/docs/ibm_is_vpc_address_prefixes_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (False, str, None) - The user-defined name for this address prefix. Names must be unique within the VPC the address prefix resides in. - - vpc (True, str, None) The VPC identifier. + name (False, str, None) + The user-defined name for this address prefix. Names must be unique within the VPC the address prefix resides in. + + generation (False, int, 2) The generation of Virtual Private Cloud infrastructure that you want to use. Supported values are 1 for VPC generation 1, and 2 for VPC generation 2 infrastructure. If this value is not specified, 2 is used by default. This can also be provided via the environment variable 'IC_GENERATION'. diff --git a/docs/ibm_is_vpc_route.rst b/docs/ibm_is_vpc_route.rst index 0079bfd65..ca4b240d3 100644 --- a/docs/ibm_is_vpc_route.rst +++ b/docs/ibm_is_vpc_route.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - vpc (True, str, None) - (Required for new resource) VPC instance ID - - - next_hop (True, str, None) - (Required for new resource) VPC route next hop value - - name (True, str, None) (Required for new resource) VPC route name @@ -51,6 +43,14 @@ Parameters (Required for new resource) VPC route destination CIDR value + vpc (True, str, None) + (Required for new resource) VPC instance ID + + + next_hop (True, str, None) + (Required for new resource) VPC route next hop value + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_vpc_routing_table.rst b/docs/ibm_is_vpc_routing_table.rst index 8a1a9bc86..e4352700d 100644 --- a/docs/ibm_is_vpc_routing_table.rst +++ b/docs/ibm_is_vpc_routing_table.rst @@ -31,22 +31,22 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - vpc (True, str, None) - (Required for new resource) The VPC identifier. - - route_direct_link_ingress (False, bool, False) If set to true, this routing table will be used to route traffic that originates from Direct Link to this VPC. - route_transit_gateway_ingress (False, bool, False) - If set to true, this routing table will be used to route traffic that originates from Transit Gateway to this VPC. - - route_vpc_zone_ingress (False, bool, False) If set to true, this routing table will be used to route traffic that originates from subnets in other zones in this VPC. + vpc (True, str, None) + (Required for new resource) The VPC identifier. + + + route_transit_gateway_ingress (False, bool, False) + If set to true, this routing table will be used to route traffic that originates from Transit Gateway to this VPC. + + name (False, str, None) The user-defined name for this routing table. diff --git a/docs/ibm_is_vpc_routing_table_route.rst b/docs/ibm_is_vpc_routing_table_route.rst index 267efda0f..9cdb66d46 100644 --- a/docs/ibm_is_vpc_routing_table_route.rst +++ b/docs/ibm_is_vpc_routing_table_route.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + next_hop (True, str, None) + (Required for new resource) If action is deliver, the next hop that packets will be delivered to. For other action values, its address will be 0.0.0.0. + + + action (False, str, deliver) + The action to perform with a packet matching the route. + + vpc (True, str, None) (Required for new resource) The VPC identifier. @@ -43,22 +51,14 @@ Parameters (Required for new resource) The zone to apply the route to. Traffic from subnets in this zone will be subject to this route. - next_hop (True, str, None) - (Required for new resource) If action is deliver, the next hop that packets will be delivered to. For other action values, its address will be 0.0.0.0. + name (False, str, None) + The user-defined name for this route. routing_table (True, str, None) (Required for new resource) The routing table identifier. - action (False, str, deliver) - The action to perform with a packet matching the route. - - - name (False, str, None) - The user-defined name for this route. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_vpn_gateway.rst b/docs/ibm_is_vpn_gateway.rst index e74262852..3f39b88ad 100644 --- a/docs/ibm_is_vpn_gateway.rst +++ b/docs/ibm_is_vpn_gateway.rst @@ -31,20 +31,20 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - tags (False, list, None) - VPN Gateway tags list - - - mode (False, str, route) - mode in VPN gateway(route/policy) + subnet (True, str, None) + (Required for new resource) VPNGateway subnet info name (True, str, None) (Required for new resource) VPN Gateway instance name - subnet (True, str, None) - (Required for new resource) VPNGateway subnet info + tags (False, list, None) + VPN Gateway tags list + + + mode (False, str, route) + mode in VPN gateway(route/policy) resource_group (False, str, None) diff --git a/docs/ibm_is_vpn_gateway_connection.rst b/docs/ibm_is_vpn_gateway_connection.rst index a7bcce04b..cb56dffd7 100644 --- a/docs/ibm_is_vpn_gateway_connection.rst +++ b/docs/ibm_is_vpn_gateway_connection.rst @@ -31,34 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - admin_state_up (False, bool, False) - VPN gateway connection admin state - - - local_cidrs (False, list, None) - VPN gateway connection local CIDRs - - name (True, str, None) (Required for new resource) VPN Gateway connection name - vpn_gateway (True, str, None) - (Required for new resource) VPN Gateway info - - - preshared_key (True, str, None) - (Required for new resource) vpn gateway - - - peer_cidrs (False, list, None) - VPN gateway connection peer CIDRs - - - interval (False, int, 2) - Interval for dead peer detection interval - - ipsec_policy (False, str, None) IP security policy for vpn gateway connection @@ -67,6 +43,10 @@ Parameters (Required for new resource) VPN gateway connection peer address + admin_state_up (False, bool, False) + VPN gateway connection admin state + + action (False, str, restart) Action detection for dead peer detection action @@ -79,6 +59,26 @@ Parameters VPN gateway connection IKE Policy + vpn_gateway (True, str, None) + (Required for new resource) VPN Gateway info + + + preshared_key (True, str, None) + (Required for new resource) vpn gateway + + + local_cidrs (False, list, None) + VPN gateway connection local CIDRs + + + peer_cidrs (False, list, None) + VPN gateway connection peer CIDRs + + + interval (False, int, 2) + Interval for dead peer detection interval + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_is_zone_info.rst b/docs/ibm_is_zone_info.rst index cbe80484d..77d103ca7 100644 --- a/docs/ibm_is_zone_info.rst +++ b/docs/ibm_is_zone_info.rst @@ -29,11 +29,11 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) + region_ (True, str, None) None - region_ (True, str, None) + name (True, str, None) None diff --git a/docs/ibm_is_zones_info.rst b/docs/ibm_is_zones_info.rst index c26b830ce..7898770a3 100644 --- a/docs/ibm_is_zones_info.rst +++ b/docs/ibm_is_zones_info.rst @@ -29,11 +29,11 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - region_ (True, str, None) + status (False, str, None) None - status (False, str, None) + region_ (True, str, None) None diff --git a/docs/ibm_kms_key.rst b/docs/ibm_kms_key.rst index a6b3af542..67dfbb10c 100644 --- a/docs/ibm_kms_key.rst +++ b/docs/ibm_kms_key.rst @@ -31,43 +31,43 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - endpoint_type (False, str, None) - public or private + key_name (True, str, None) + (Required for new resource) Key name - force_delete (False, bool, False) - set to true to force delete the key + standard_key (False, bool, False) + Standard key type - expiration_date (False, str, None) - The date the key material expires. The date format follows RFC 3339. You can set an expiration date on any key on its creation. A key moves into the Deactivated state within one hour past its expiration date, if one is assigned. If you create a key without specifying an expiration date, the key does not expire + payload (False, str, None) + None key_ring_id (False, str, default) Key Ring for the Key - iv_value (False, str, None) + encrypted_nonce (False, str, None) Only for imported root key - key_name (True, str, None) - (Required for new resource) Key name + endpoint_type (False, str, None) + public or private - instance_id (True, str, None) - (Required for new resource) Key protect or hpcs instance GUID or CRN + force_delete (False, bool, False) + set to true to force delete the key - standard_key (False, bool, False) - Standard key type + expiration_date (False, str, None) + The date the key material expires. The date format follows RFC 3339. You can set an expiration date on any key on its creation. A key moves into the Deactivated state within one hour past its expiration date, if one is assigned. If you create a key without specifying an expiration date, the key does not expire - payload (False, str, None) - None + instance_id (True, str, None) + (Required for new resource) Key protect or hpcs instance GUID or CRN - encrypted_nonce (False, str, None) + iv_value (False, str, None) Only for imported root key diff --git a/docs/ibm_kms_key_policies_info.rst b/docs/ibm_kms_key_policies_info.rst index 3a85fe7de..a28c60bf8 100644 --- a/docs/ibm_kms_key_policies_info.rst +++ b/docs/ibm_kms_key_policies_info.rst @@ -29,10 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - policies (False, list, None) - Creates or updates one or more policies for the specified key - - instance_id (True, str, None) Key protect or hpcs instance GUID @@ -45,6 +41,10 @@ Parameters Key ID of the Key + policies (False, list, None) + Creates or updates one or more policies for the specified key + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_kms_key_rings_info.rst b/docs/ibm_kms_key_rings_info.rst index d581c740b..442651bb5 100644 --- a/docs/ibm_kms_key_rings_info.rst +++ b/docs/ibm_kms_key_rings_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - instance_id (True, str, None) - Key protect or hpcs instance GUID - - endpoint_type (False, str, public) public or private + instance_id (True, str, None) + Key protect or hpcs instance GUID + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_kms_keys_info.rst b/docs/ibm_kms_keys_info.rst index c75771c85..826153aac 100644 --- a/docs/ibm_kms_keys_info.rst +++ b/docs/ibm_kms_keys_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + alias (False, str, None) + The name of the key to be fetched + + key_id (False, str, None) None @@ -49,10 +53,6 @@ Parameters Limit till the keys to be fetched - alias (False, str, None) - The name of the key to be fetched - - iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_kp_key.rst b/docs/ibm_kp_key.rst index 3b8731f47..05f1dd1b9 100644 --- a/docs/ibm_kp_key.rst +++ b/docs/ibm_kp_key.rst @@ -35,28 +35,28 @@ Parameters (Required for new resource) Key protect instance ID - key_name (True, str, None) - (Required for new resource) Key name + encrypted_nonce (False, str, None) + Only for imported root key standard_key (False, bool, False) Standard key type - payload (False, str, None) - None + key_name (True, str, None) + (Required for new resource) Key name iv_value (False, str, None) Only for imported root key - force_delete (False, bool, False) - set to true to force delete the key + payload (False, str, None) + None - encrypted_nonce (False, str, None) - Only for imported root key + force_delete (False, bool, False) + set to true to force delete the key id (False, str, None) diff --git a/docs/ibm_lb.rst b/docs/ibm_lb.rst index a53b10453..b3fbbcd23 100644 --- a/docs/ibm_lb.rst +++ b/docs/ibm_lb.rst @@ -31,28 +31,28 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - connections (True, int, None) - (Required for new resource) Connections value + datacenter (True, str, None) + (Required for new resource) Datacenter name info - ha_enabled (False, bool, False) - true if High availability is enabled + dedicated (False, bool, False) + Boolena value true if Load balncer is dedicated type tags (False, list, None) Tags associated with resource - datacenter (True, str, None) - (Required for new resource) Datacenter name info + connections (True, int, None) + (Required for new resource) Connections value - security_certificate_id (False, int, None) - Security certificate ID + ha_enabled (False, bool, False) + true if High availability is enabled - dedicated (False, bool, False) - Boolena value true if Load balncer is dedicated type + security_certificate_id (False, int, None) + Security certificate ID ssl_offload (False, bool, False) diff --git a/docs/ibm_lb_service.rst b/docs/ibm_lb_service.rst index f945aa32e..619fb3434 100644 --- a/docs/ibm_lb_service.rst +++ b/docs/ibm_lb_service.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + service_group_id (True, int, None) + (Required for new resource) service group ID + + + ip_address_id (True, int, None) + (Required for new resource) IP Address ID + + port (True, int, None) (Required for new resource) Port number @@ -51,14 +59,6 @@ Parameters Tags for the resource - service_group_id (True, int, None) - (Required for new resource) service group ID - - - ip_address_id (True, int, None) - (Required for new resource) IP Address ID - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_lb_service_group.rst b/docs/ibm_lb_service_group.rst index 28faa8436..0ef0cfa65 100644 --- a/docs/ibm_lb_service_group.rst +++ b/docs/ibm_lb_service_group.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + load_balancer_id (True, int, None) + (Required for new resource) Loadbalancer ID + + + routing_method (True, str, None) + (Required for new resource) Routing method + + routing_type (True, str, None) (Required for new resource) Routing type @@ -47,14 +55,6 @@ Parameters (Required for new resource) Allocation type - routing_method (True, str, None) - (Required for new resource) Routing method - - - load_balancer_id (True, int, None) - (Required for new resource) Loadbalancer ID - - port (True, int, None) (Required for new resource) Port number diff --git a/docs/ibm_lb_vpx.rst b/docs/ibm_lb_vpx.rst index 9f2be10fd..1f6a28f2d 100644 --- a/docs/ibm_lb_vpx.rst +++ b/docs/ibm_lb_vpx.rst @@ -31,34 +31,18 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - datacenter (True, str, None) - (Required for new resource) Datacenter name - - - speed (True, int, None) - (Required for new resource) Speed value - - - public_subnet (False, str, None) - Public subnet - - private_subnet (False, str, None) Private subnet - plan (True, str, None) - (Required for new resource) Plan info + datacenter (True, str, None) + (Required for new resource) Datacenter name ip_count (True, int, None) (Required for new resource) IP address count - public_vlan_id (False, int, None) - Piblic VLAN id - - private_vlan_id (False, int, None) Private VLAN id @@ -67,10 +51,26 @@ Parameters List of the tags + public_vlan_id (False, int, None) + Piblic VLAN id + + + public_subnet (False, str, None) + Public subnet + + + speed (True, int, None) + (Required for new resource) Speed value + + version (True, str, None) (Required for new resource) version info + plan (True, str, None) + (Required for new resource) Plan info + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_lb_vpx_service.rst b/docs/ibm_lb_vpx_service.rst index 5870d73d0..5779a4f9b 100644 --- a/docs/ibm_lb_vpx_service.rst +++ b/docs/ibm_lb_vpx_service.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - (Required for new resource) name - - destination_ip_address (True, str, None) (Required for new resource) Destination IP Address @@ -47,22 +43,26 @@ Parameters (Required for new resource) Weight value - connection_limit (True, int, None) - (Required for new resource) Number of connections limit - - health_check (True, str, None) (Required for new resource) Health check info - usip (False, str, False) - usip info - - vip_id (True, str, None) (Required for new resource) VIP id + name (True, str, None) + (Required for new resource) name + + + connection_limit (True, int, None) + (Required for new resource) Number of connections limit + + + usip (False, str, False) + usip info + + tags (False, list, None) list of tags associated with the resource diff --git a/docs/ibm_lb_vpx_vip.rst b/docs/ibm_lb_vpx_vip.rst index 43c4aea8a..855b74df0 100644 --- a/docs/ibm_lb_vpx_vip.rst +++ b/docs/ibm_lb_vpx_vip.rst @@ -31,18 +31,26 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - nad_controller_id (True, int, None) - (Required for new resource) NAD controller ID + name (True, str, None) + (Required for new resource) Name - source_port (True, int, None) - (Required for new resource) Source Port number + type (True, str, None) + (Required for new resource) Type security_certificate_id (False, int, None) security certificate ID + nad_controller_id (True, int, None) + (Required for new resource) NAD controller ID + + + persistence (False, str, None) + Persistance value + + virtual_ip_address (True, str, None) (Required for new resource) Virtual IP address @@ -55,16 +63,8 @@ Parameters (Required for new resource) Load balancing method - persistence (False, str, None) - Persistance value - - - name (True, str, None) - (Required for new resource) Name - - - type (True, str, None) - (Required for new resource) Type + source_port (True, int, None) + (Required for new resource) Source Port number id (False, str, None) diff --git a/docs/ibm_lbaas.rst b/docs/ibm_lbaas.rst index 8a52b4ddf..15cfbdb50 100644 --- a/docs/ibm_lbaas.rst +++ b/docs/ibm_lbaas.rst @@ -35,32 +35,32 @@ Parameters Description of a load balancer. - ssl_ciphers (False, list, None) - None + subnets (True, list, None) + (Required for new resource) The subnet where this Load Balancer will be provisioned. - name (True, str, None) - (Required for new resource) The load balancer's name. + protocols (False, list, None) + Protocols to be assigned to this load balancer. - wait_time_minutes (False, int, 90) - None + name (True, str, None) + (Required for new resource) The load balancer's name. - subnets (True, list, None) - (Required for new resource) The subnet where this Load Balancer will be provisioned. + type (False, str, PUBLIC) + Specifies if a load balancer is public or private use_system_public_ip_pool (False, bool, None) in public loadbalancer - Public IP address allocation done by system public IP pool or public subnet. - protocols (False, list, None) - Protocols to be assigned to this load balancer. + ssl_ciphers (False, list, None) + None - type (False, str, PUBLIC) - Specifies if a load balancer is public or private + wait_time_minutes (False, int, 90) + None id (False, str, None) diff --git a/docs/ibm_lbaas_health_monitor.rst b/docs/ibm_lbaas_health_monitor.rst index e07c22fcb..cca6eccd1 100644 --- a/docs/ibm_lbaas_health_monitor.rst +++ b/docs/ibm_lbaas_health_monitor.rst @@ -31,22 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - url_path (False, str, /) - URL Path - - - monitor_id (True, str, None) - (Required for new resource) Monitor ID - - - lbaas_id (True, str, None) - (Required for new resource) LBAAS id - - - protocol (True, str, None) - (Required for new resource) Protocol value - - port (True, int, None) (Required for new resource) Port number @@ -63,6 +47,22 @@ Parameters Timeout in seconds + url_path (False, str, /) + URL Path + + + monitor_id (True, str, None) + (Required for new resource) Monitor ID + + + lbaas_id (True, str, None) + (Required for new resource) LBAAS id + + + protocol (True, str, None) + (Required for new resource) Protocol value + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_multi_vlan_firewall.rst b/docs/ibm_multi_vlan_firewall.rst index a57235bce..5f46be87a 100644 --- a/docs/ibm_multi_vlan_firewall.rst +++ b/docs/ibm_multi_vlan_firewall.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + addon_configuration (False, list, None) + High Availability - [Web Filtering Add-on, NGFW Add-on, AV Add-on] or [Web Filtering Add-on, NGFW Add-on, AV Add-on] + + + pod (True, str, None) + (Required for new resource) POD name + + name (True, str, None) (Required for new resource) name @@ -43,14 +51,6 @@ Parameters (Required for new resource) Datacenter name - addon_configuration (False, list, None) - High Availability - [Web Filtering Add-on, NGFW Add-on, AV Add-on] or [Web Filtering Add-on, NGFW Add-on, AV Add-on] - - - pod (True, str, None) - (Required for new resource) POD name - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_network_gateway.rst b/docs/ibm_network_gateway.rst index 96109b173..daf7a9c32 100644 --- a/docs/ibm_network_gateway.rst +++ b/docs/ibm_network_gateway.rst @@ -31,22 +31,22 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - ssh_key_ids (False, list, None) - None - - - members (True, list, None) - (Required for new resource) The hardware members of this network Gateway - - name (True, str, None) (Required for new resource) The name of the gateway + ssh_key_ids (False, list, None) + None + + post_install_script_uri (False, str, None) None + members (True, list, None) + (Required for new resource) The hardware members of this network Gateway + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_network_gateway_vlan_association.rst b/docs/ibm_network_gateway_vlan_association.rst index cda0e4e0b..0cd33f86c 100644 --- a/docs/ibm_network_gateway_vlan_association.rst +++ b/docs/ibm_network_gateway_vlan_association.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - gateway_id (True, int, None) - (Required for new resource) Gateway instance ID - - network_vlan_id (True, int, None) (Required for new resource) The Identifier of the VLAN to be associated @@ -43,6 +39,10 @@ Parameters Indicates if the VLAN should be in bypass or routed modes + gateway_id (True, int, None) + (Required for new resource) Gateway instance ID + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_network_vlan.rst b/docs/ibm_network_vlan.rst index 1e50e7d94..e7ac70bb9 100644 --- a/docs/ibm_network_vlan.rst +++ b/docs/ibm_network_vlan.rst @@ -39,10 +39,6 @@ Parameters (Required for new resource) Datacenter name - name (False, str, None) - VLAN name - - router_hostname (False, str, None) router host name @@ -51,6 +47,10 @@ Parameters (Required for new resource) VLAN type + name (False, str, None) + VLAN name + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_network_vlan_info.rst b/docs/ibm_network_vlan_info.rst index 31f6bbc64..73e775f8c 100644 --- a/docs/ibm_network_vlan_info.rst +++ b/docs/ibm_network_vlan_info.rst @@ -29,15 +29,15 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - number (False, int, None) + router_hostname (False, str, None) None - router_hostname (False, str, None) + name (False, str, None) None - name (False, str, None) + number (False, int, None) None diff --git a/docs/ibm_ob_logging.rst b/docs/ibm_ob_logging.rst index eede61de1..57613ada4 100644 --- a/docs/ibm_ob_logging.rst +++ b/docs/ibm_ob_logging.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - logdna_ingestion_key (False, str, None) - LogDNA ingestion key - - - private_endpoint (False, bool, None) - Add this option to connect to your LogDNA service instance through the private service endpoint - - cluster (True, str, None) (Required for new resource) Name or ID of the cluster to be used. @@ -47,6 +39,14 @@ Parameters (Required for new resource) ID of the LogDNA service instance to latch + private_endpoint (False, bool, None) + Add this option to connect to your LogDNA service instance through the private service endpoint + + + logdna_ingestion_key (False, str, None) + LogDNA ingestion key + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_ob_monitoring.rst b/docs/ibm_ob_monitoring.rst index 78c6c9cf2..63fa89c01 100644 --- a/docs/ibm_ob_monitoring.rst +++ b/docs/ibm_ob_monitoring.rst @@ -31,14 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - cluster (True, str, None) - (Required for new resource) Name or ID of the cluster to be used. - - private_endpoint (False, bool, None) Add this option to connect to your Sysdig service instance through the private service endpoint + cluster (True, str, None) + (Required for new resource) Name or ID of the cluster to be used. + + instance_id (True, str, None) (Required for new resource) ID of the Sysdig service instance to latch diff --git a/docs/ibm_org.rst b/docs/ibm_org.rst index c46c161a2..911c37ace 100644 --- a/docs/ibm_org.rst +++ b/docs/ibm_org.rst @@ -31,6 +31,18 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + name (True, str, None) + (Required for new resource) Org name, for example myorg@domain + + + org_quota_definition_guid (False, str, None) + Org quota guid + + + billing_managers (False, list, None) + The IBMID of the users who will have billing manager role in this org, ex - user@example.com + + managers (False, list, None) The IBMID of the users who will have manager role in this org, ex - user@example.com @@ -47,18 +59,6 @@ Parameters None - name (True, str, None) - (Required for new resource) Org name, for example myorg@domain - - - org_quota_definition_guid (False, str, None) - Org quota guid - - - billing_managers (False, list, None) - The IBMID of the users who will have billing manager role in this org, ex - user@example.com - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_pi_cloud_connection.rst b/docs/ibm_pi_cloud_connection.rst index 17d5598d5..516a9b9d8 100644 --- a/docs/ibm_pi_cloud_connection.rst +++ b/docs/ibm_pi_cloud_connection.rst @@ -39,40 +39,40 @@ Parameters (Required for new resource) Speed of the cloud connection (speed in megabits per second) - pi_cloud_connection_gre_cidr (False, str, None) - GRE network in CIDR notation - - - pi_cloud_connection_vpc_crns (False, list, None) - Set of VPCs to attach to this cloud connection + pi_cloud_connection_global_routing (False, bool, False) + Enable global routing for this cloud connection pi_cloud_connection_metered (False, bool, False) Enable metered for this cloud connection - pi_cloud_connection_networks (False, list, None) - Set of Networks to attach to this cloud connection + pi_cloud_connection_gre_destination_address (False, str, None) + GRE destination IP address pi_cloud_connection_vpc_enabled (False, bool, False) Enable VPC for this cloud connection - pi_cloud_connection_name (True, str, None) - (Required for new resource) Name of the cloud connection + pi_cloud_connection_vpc_crns (False, list, None) + Set of VPCs to attach to this cloud connection - pi_cloud_connection_global_routing (False, bool, False) - Enable global routing for this cloud connection + pi_cloud_connection_networks (False, list, None) + Set of Networks to attach to this cloud connection pi_cloud_connection_classic_enabled (False, bool, False) Enable classic endpoint destination - pi_cloud_connection_gre_destination_address (False, str, None) - GRE destination IP address + pi_cloud_connection_name (True, str, None) + (Required for new resource) Name of the cloud connection + + + pi_cloud_connection_gre_cidr (False, str, None) + GRE network in CIDR notation id (False, str, None) diff --git a/docs/ibm_pi_console_language.rst b/docs/ibm_pi_console_language.rst index e7ff80f82..38fa4b2df 100644 --- a/docs/ibm_pi_console_language.rst +++ b/docs/ibm_pi_console_language.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + pi_language_code (True, str, None) + (Required for new resource) Language code + + pi_cloud_instance_id (True, str, None) (Required for new resource) PI cloud instance ID @@ -39,10 +43,6 @@ Parameters (Required for new resource) The unique identifier or name of the instance - pi_language_code (True, str, None) - (Required for new resource) Language code - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_pi_dhcp_info.rst b/docs/ibm_pi_dhcp_info.rst index 1fe134c34..a8e1e4d07 100644 --- a/docs/ibm_pi_dhcp_info.rst +++ b/docs/ibm_pi_dhcp_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_dhcp_id (True, str, None) - The ID of the DHCP Server - - pi_cloud_instance_id (True, str, None) None + pi_dhcp_id (True, str, None) + The ID of the DHCP Server + + zone (False, str, None) Denotes which IBM Cloud zone to connect to in multizone environment. This can also be provided via the environment variable 'IC_ZONE'. diff --git a/docs/ibm_pi_ike_policy.rst b/docs/ibm_pi_ike_policy.rst index 0b9bef257..b7ee5f07e 100644 --- a/docs/ibm_pi_ike_policy.rst +++ b/docs/ibm_pi_ike_policy.rst @@ -31,38 +31,38 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_cloud_instance_id (True, str, None) - (Required for new resource) PI cloud instance ID - - - pi_policy_encryption (True, str, None) - (Required for new resource) Encryption of the IKE Policy - - pi_policy_key_lifetime (True, int, None) (Required for new resource) Policy key lifetime - pi_policy_version (True, int, None) - (Required for new resource) Version of the IKE Policy - - - pi_policy_name (True, str, None) - (Required for new resource) Name of the IKE Policy + pi_policy_preshared_key (True, str, None) + (Required for new resource) Preshared key used in this IKE Policy (length of preshared key must be even) pi_policy_dh_group (True, int, None) (Required for new resource) DH group of the IKE Policy - pi_policy_preshared_key (True, str, None) - (Required for new resource) Preshared key used in this IKE Policy (length of preshared key must be even) + pi_policy_encryption (True, str, None) + (Required for new resource) Encryption of the IKE Policy + + + pi_policy_version (True, int, None) + (Required for new resource) Version of the IKE Policy pi_policy_authentication (False, str, none) Authentication for the IKE Policy + pi_cloud_instance_id (True, str, None) + (Required for new resource) PI cloud instance ID + + + pi_policy_name (True, str, None) + (Required for new resource) Name of the IKE Policy + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_pi_image.rst b/docs/ibm_pi_image.rst index d63ec73df..e27399f99 100644 --- a/docs/ibm_pi_image.rst +++ b/docs/ibm_pi_image.rst @@ -31,44 +31,44 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_image_name (True, str, None) - (Required for new resource) Image name + pi_image_access_key (False, str, None) + Cloud Object Storage access key; required for buckets with private access - pi_image_id (False, str, None) - Instance image id + pi_image_secret_key (False, str, None) + Cloud Object Storage secret key; required for buckets with private access - pi_image_bucket_access (False, str, public) - Indicates if the bucket has public or private access + pi_image_bucket_region (False, str, None) + Cloud Object Storage region - pi_image_access_key (False, str, None) - Cloud Object Storage access key; required for buckets with private access + pi_image_storage_type (False, str, None) + Type of storage - pi_image_bucket_region (False, str, None) - Cloud Object Storage region + pi_image_bucket_name (False, str, None) + Cloud Object Storage bucket name; bucket-name[/optional/folder] - pi_image_bucket_file_name (False, str, None) - Cloud Object Storage image filename + pi_image_name (True, str, None) + (Required for new resource) Image name - pi_image_storage_type (False, str, None) - Type of storage + pi_image_id (False, str, None) + Instance image id - pi_cloud_instance_id (True, str, None) - (Required for new resource) PI cloud instance ID + pi_image_bucket_access (False, str, public) + Indicates if the bucket has public or private access - pi_image_bucket_name (False, str, None) - Cloud Object Storage bucket name; bucket-name[/optional/folder] + pi_image_bucket_file_name (False, str, None) + Cloud Object Storage image filename - pi_image_secret_key (False, str, None) - Cloud Object Storage secret key; required for buckets with private access + pi_cloud_instance_id (True, str, None) + (Required for new resource) PI cloud instance ID id (False, str, None) diff --git a/docs/ibm_pi_image_info.rst b/docs/ibm_pi_image_info.rst index 98d012499..ce8940a49 100644 --- a/docs/ibm_pi_image_info.rst +++ b/docs/ibm_pi_image_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_cloud_instance_id (True, str, None) - None - - pi_image_name (True, str, None) Imagename Name to be used for pvminstances + pi_cloud_instance_id (True, str, None) + None + + zone (False, str, None) Denotes which IBM Cloud zone to connect to in multizone environment. This can also be provided via the environment variable 'IC_ZONE'. diff --git a/docs/ibm_pi_instance.rst b/docs/ibm_pi_instance.rst index cb489ee04..d4aca3d17 100644 --- a/docs/ibm_pi_instance.rst +++ b/docs/ibm_pi_instance.rst @@ -31,124 +31,124 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_replication_scheme (False, str, suffix) - Replication scheme - - - pi_health_status (False, str, OK) - Allow the user to set the status of the lpar so that they can connect to it faster - - - pi_affinity_volume (False, str, None) - Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided + pi_storage_pool (False, str, None) + Storage Pool for server deployment; if provided then pi_affinity_policy and pi_storage_type will be ignored pi_anti_affinity_volumes (False, list, None) List of volumes to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided - pi_storage_pool_affinity (False, bool, True) - Indicates if all volumes attached to the server must reside in the same storage pool + pi_proc_type (False, str, None) + Instance processor type pi_sap_profile_id (False, str, None) SAP Profile ID for the amount of cores and memory - pi_processors (False, float, None) - Processors count + pi_pin_policy (False, str, none) + Pin Policy of the instance - pi_proc_type (False, str, None) - Instance processor type + pi_image_id (True, str, None) + (Required for new resource) PI instance image id - pi_volume_ids (False, list, None) - List of PI volumes + pi_sys_type (False, str, None) + PI Instance system type - pi_affinity_instance (False, str, None) - PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and pi_affinity_volume is not provided + pi_replication_policy (False, str, none) + Replication policy for the PI Instance - pi_network (True, list, None) - (Required for new resource) List of one or more networks to attach to the instance + pi_affinity_policy (False, str, None) + Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified - pi_migratable (False, bool, None) - set to true to enable migration of the PI instance + pi_affinity_volume (False, str, None) + Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided - pi_storage_pool (False, str, None) - Storage Pool for server deployment; if provided then pi_affinity_policy and pi_storage_type will be ignored + pi_memory (False, float, None) + Memory size - pi_instance_name (True, str, None) - (Required for new resource) PI Instance name + pi_cloud_instance_id (True, str, None) + (Required for new resource) This is the Power Instance id that is assigned to the account - pi_replicants (False, int, 1) - PI Instance replicas count + pi_volume_ids (False, list, None) + List of PI volumes - pi_cloud_instance_id (True, str, None) - (Required for new resource) This is the Power Instance id that is assigned to the account + pi_key_pair_name (False, str, None) + SSH key name - pi_storage_type (False, str, None) - Storage type for server deployment + pi_replicants (False, int, 1) + PI Instance replicas count - pi_affinity_policy (False, str, None) - Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified + pi_storage_pool_affinity (False, bool, True) + Indicates if all volumes attached to the server must reside in the same storage pool - pi_image_id (True, str, None) - (Required for new resource) PI instance image id + pi_virtual_cores_assigned (False, int, None) + Virtual Cores Assigned to the PVMInstance - pi_storage_connection (False, str, None) - Storage Connectivity Group for server deployment + pi_replication_scheme (False, str, suffix) + Replication scheme - pi_placement_group_id (False, str, None) - Placement group ID + pi_migratable (False, bool, None) + set to true to enable migration of the PI instance pi_user_data (False, str, None) Base64 encoded data to be passed in for invoking a cloud init script - pi_replication_policy (False, str, none) - Replication policy for the PI Instance + pi_anti_affinity_instances (False, list, None) + List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided - pi_pin_policy (False, str, none) - Pin Policy of the instance + pi_placement_group_id (False, str, None) + Placement group ID - pi_key_pair_name (False, str, None) - SSH key name + pi_affinity_instance (False, str, None) + PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and pi_affinity_volume is not provided - pi_memory (False, float, None) - Memory size + pi_storage_connection (False, str, None) + Storage Connectivity Group for server deployment - pi_virtual_cores_assigned (False, int, None) - Virtual Cores Assigned to the PVMInstance + pi_network (True, list, None) + (Required for new resource) List of one or more networks to attach to the instance + + + pi_instance_name (True, str, None) + (Required for new resource) PI Instance name pi_license_repository_capacity (False, int, None) The VTL license repository capacity TB value - pi_anti_affinity_instances (False, list, None) - List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided + pi_storage_type (False, str, None) + Storage type for server deployment - pi_sys_type (False, str, None) - PI Instance system type + pi_processors (False, float, None) + Processors count + + + pi_health_status (False, str, OK) + Allow the user to set the status of the lpar so that they can connect to it faster id (False, str, None) diff --git a/docs/ibm_pi_instance_ip_info.rst b/docs/ibm_pi_instance_ip_info.rst index a13536d3a..c5ab687ed 100644 --- a/docs/ibm_pi_instance_ip_info.rst +++ b/docs/ibm_pi_instance_ip_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + pi_instance_name (True, str, None) + Server Name to be used for pvminstances + + pi_cloud_instance_id (True, str, None) None @@ -37,10 +41,6 @@ Parameters None - pi_instance_name (True, str, None) - Server Name to be used for pvminstances - - zone (False, str, None) Denotes which IBM Cloud zone to connect to in multizone environment. This can also be provided via the environment variable 'IC_ZONE'. diff --git a/docs/ibm_pi_ipsec_policy.rst b/docs/ibm_pi_ipsec_policy.rst index dc0fb1baa..51a837e4d 100644 --- a/docs/ibm_pi_ipsec_policy.rst +++ b/docs/ibm_pi_ipsec_policy.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_policy_encryption (True, str, None) - (Required for new resource) Encryption of the IPSec Policy - - - pi_policy_key_lifetime (True, int, None) - (Required for new resource) Policy key lifetime - - pi_policy_pfs (True, bool, None) (Required for new resource) Perfect Forward Secrecy @@ -59,6 +51,14 @@ Parameters (Required for new resource) DH group of the IPSec Policy + pi_policy_encryption (True, str, None) + (Required for new resource) Encryption of the IPSec Policy + + + pi_policy_key_lifetime (True, int, None) + (Required for new resource) Policy key lifetime + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_pi_key.rst b/docs/ibm_pi_key.rst index 462302951..05b4f9a01 100644 --- a/docs/ibm_pi_key.rst +++ b/docs/ibm_pi_key.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + pi_cloud_instance_id (True, str, None) + (Required for new resource) PI cloud instance ID + + pi_key_name (True, str, None) (Required for new resource) Key name in the PI instance @@ -39,10 +43,6 @@ Parameters (Required for new resource) PI instance key info - pi_cloud_instance_id (True, str, None) - (Required for new resource) PI cloud instance ID - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_pi_network.rst b/docs/ibm_pi_network.rst index 19f4e4026..2fd878705 100644 --- a/docs/ibm_pi_network.rst +++ b/docs/ibm_pi_network.rst @@ -31,8 +31,12 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_cloud_instance_id (True, str, None) - (Required for new resource) PI cloud instance ID + pi_network_type (True, str, None) + (Required for new resource) PI network type + + + pi_dns (False, list, None) + List of PI network DNS name pi_cidr (False, str, None) @@ -43,20 +47,16 @@ Parameters PI network gateway - pi_network_jumbo (False, bool, None) - PI network enable MTU Jumbo option - - - pi_network_type (True, str, None) - (Required for new resource) PI network type - - pi_network_name (True, str, None) (Required for new resource) PI network name - pi_dns (False, list, None) - List of PI network DNS name + pi_network_jumbo (False, bool, None) + PI network enable MTU Jumbo option + + + pi_cloud_instance_id (True, str, None) + (Required for new resource) PI cloud instance ID id (False, str, None) diff --git a/docs/ibm_pi_network_info.rst b/docs/ibm_pi_network_info.rst index 02993e850..b538c35c3 100644 --- a/docs/ibm_pi_network_info.rst +++ b/docs/ibm_pi_network_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_network_name (True, str, None) - Network Name to be used for pvminstances - - pi_cloud_instance_id (True, str, None) None + pi_network_name (True, str, None) + Network Name to be used for pvminstances + + zone (False, str, None) Denotes which IBM Cloud zone to connect to in multizone environment. This can also be provided via the environment variable 'IC_ZONE'. diff --git a/docs/ibm_pi_network_port.rst b/docs/ibm_pi_network_port.rst index c9fdafc41..fdc86caf8 100644 --- a/docs/ibm_pi_network_port.rst +++ b/docs/ibm_pi_network_port.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_network_name (True, str, None) - (Required for new resource) - - - pi_cloud_instance_id (True, str, None) - (Required for new resource) - - pi_network_port_description (False, str, None) None @@ -47,6 +39,14 @@ Parameters None + pi_network_name (True, str, None) + (Required for new resource) + + + pi_cloud_instance_id (True, str, None) + (Required for new resource) + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_pi_network_port_attach.rst b/docs/ibm_pi_network_port_attach.rst index 56cf87528..049b75416 100644 --- a/docs/ibm_pi_network_port_attach.rst +++ b/docs/ibm_pi_network_port_attach.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + port_id (True, str, None) + (Required for new resource) + + + pi_cloud_instance_id (True, str, None) + (Required for new resource) + + pi_instance_name (True, str, None) (Required for new resource) Instance name to attach the network port to @@ -43,14 +51,6 @@ Parameters A human readable description for this network Port - port_id (True, str, None) - (Required for new resource) - - - pi_cloud_instance_id (True, str, None) - (Required for new resource) - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_pi_operations.rst b/docs/ibm_pi_operations.rst index e36daa9e4..7c2248348 100644 --- a/docs/ibm_pi_operations.rst +++ b/docs/ibm_pi_operations.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_operation (True, str, None) - (Required for new resource) PI instance operation type - - pi_cloud_instance_id (True, str, None) (Required for new resource) PI Cloud instnce id @@ -43,6 +39,10 @@ Parameters (Required for new resource) PI instance Operation server name + pi_operation (True, str, None) + (Required for new resource) PI instance operation type + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_pi_placement_group.rst b/docs/ibm_pi_placement_group.rst index 54f1efcea..1d11bca90 100644 --- a/docs/ibm_pi_placement_group.rst +++ b/docs/ibm_pi_placement_group.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + pi_placement_group_name (True, str, None) + (Required for new resource) Name of the placement group + + pi_placement_group_policy (True, str, None) (Required for new resource) Policy of the placement group @@ -39,10 +43,6 @@ Parameters (Required for new resource) PI cloud instance ID - pi_placement_group_name (True, str, None) - (Required for new resource) Name of the placement group - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_pi_placement_group_info.rst b/docs/ibm_pi_placement_group_info.rst index f27debe65..c62f6125d 100644 --- a/docs/ibm_pi_placement_group_info.rst +++ b/docs/ibm_pi_placement_group_info.rst @@ -29,11 +29,11 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_placement_group_name (True, str, None) + pi_cloud_instance_id (True, str, None) None - pi_cloud_instance_id (True, str, None) + pi_placement_group_name (True, str, None) None diff --git a/docs/ibm_pi_snapshot.rst b/docs/ibm_pi_snapshot.rst index ce3667ca4..2ce5fa513 100644 --- a/docs/ibm_pi_snapshot.rst +++ b/docs/ibm_pi_snapshot.rst @@ -31,8 +31,8 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_snap_shot_name (True, str, None) - (Required for new resource) Unique name of the snapshot + pi_volume_ids (False, list, None) + List of PI volumes pi_cloud_instance_id (True, str, None) @@ -43,12 +43,12 @@ Parameters Description of the PVM instance snapshot - pi_instance_name (True, str, None) - (Required for new resource) Instance name / id of the pvm + pi_snap_shot_name (True, str, None) + (Required for new resource) Unique name of the snapshot - pi_volume_ids (False, list, None) - List of PI volumes + pi_instance_name (True, str, None) + (Required for new resource) Instance name / id of the pvm id (False, str, None) diff --git a/docs/ibm_pi_volume.rst b/docs/ibm_pi_volume.rst index c08dc1301..41f29b8ee 100644 --- a/docs/ibm_pi_volume.rst +++ b/docs/ibm_pi_volume.rst @@ -31,48 +31,48 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_anti_affinity_volumes (False, list, None) - List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided - - - pi_cloud_instance_id (True, str, None) - (Required for new resource) Cloud Instance ID - This is the service_instance_id. + pi_volume_pool (False, str, None) + Volume pool where the volume will be created; if provided then pi_volume_type and pi_affinity_policy values will be ignored - pi_volume_type (False, str, None) - Type of Disk, required if pi_affinity_policy and pi_volume_pool not provided, otherwise ignored + pi_affinity_volume (False, str, None) + Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided - pi_affinity_policy (False, str, None) - Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified + pi_anti_affinity_instances (False, list, None) + List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided - pi_volume_shareable (False, bool, None) - Flag to indicate if the volume can be shared across multiple instances? + pi_volume_name (True, str, None) + (Required for new resource) Volume Name to create pi_volume_size (True, float, None) (Required for new resource) Size of the volume in GB - pi_volume_pool (False, str, None) - Volume pool where the volume will be created; if provided then pi_volume_type and pi_affinity_policy values will be ignored + pi_affinity_instance (False, str, None) + PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided - pi_anti_affinity_instances (False, list, None) - List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided + pi_cloud_instance_id (True, str, None) + (Required for new resource) Cloud Instance ID - This is the service_instance_id. - pi_volume_name (True, str, None) - (Required for new resource) Volume Name to create + pi_volume_shareable (False, bool, None) + Flag to indicate if the volume can be shared across multiple instances? - pi_affinity_volume (False, str, None) - Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided + pi_volume_type (False, str, None) + Type of Disk, required if pi_affinity_policy and pi_volume_pool not provided, otherwise ignored - pi_affinity_instance (False, str, None) - PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided + pi_anti_affinity_volumes (False, list, None) + List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided + + + pi_affinity_policy (False, str, None) + Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified id (False, str, None) diff --git a/docs/ibm_pi_vpn_connection.rst b/docs/ibm_pi_vpn_connection.rst index 1ce4c0fd5..9f29df9ed 100644 --- a/docs/ibm_pi_vpn_connection.rst +++ b/docs/ibm_pi_vpn_connection.rst @@ -31,36 +31,36 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - pi_cloud_instance_id (True, str, None) - (Required for new resource) PI cloud instance ID - - - pi_vpn_connection_name (True, str, None) - (Required for new resource) Name of the VPN Connection + pi_peer_subnets (True, list, None) + (Required for new resource) Set of CIDR of peer subnets - pi_ipsec_policy_id (True, str, None) - (Required for new resource) Unique identifier of IPSec Policy selected for this VPN Connection + pi_networks (True, list, None) + (Required for new resource) Set of network IDs to attach to this VPN connection - pi_peer_gateway_address (True, str, None) - (Required for new resource) Peer Gateway address + pi_vpn_connection_name (True, str, None) + (Required for new resource) Name of the VPN Connection pi_ike_policy_id (True, str, None) (Required for new resource) Unique identifier of IKE Policy selected for this VPN Connection + pi_ipsec_policy_id (True, str, None) + (Required for new resource) Unique identifier of IPSec Policy selected for this VPN Connection + + pi_vpn_connection_mode (True, str, None) (Required for new resource) Mode used by this VPN Connection, either 'policy' or 'route' - pi_networks (True, list, None) - (Required for new resource) Set of network IDs to attach to this VPN connection + pi_peer_gateway_address (True, str, None) + (Required for new resource) Peer Gateway address - pi_peer_subnets (True, list, None) - (Required for new resource) Set of CIDR of peer subnets + pi_cloud_instance_id (True, str, None) + (Required for new resource) PI cloud instance ID id (False, str, None) diff --git a/docs/ibm_pn_application_chrome.rst b/docs/ibm_pn_application_chrome.rst index 6be882b2c..ddf0b882f 100644 --- a/docs/ibm_pn_application_chrome.rst +++ b/docs/ibm_pn_application_chrome.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + web_site_url (True, str, None) + (Required for new resource) The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush. + + guid (True, str, None) (Required for new resource) Unique guid of the push notification instance. @@ -39,10 +43,6 @@ Parameters (Required for new resource) A server key that gives the push service an authorized access to Google services that is used for Chrome Web Push. - web_site_url (True, str, None) - (Required for new resource) The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_resource_instance.rst b/docs/ibm_resource_instance.rst index ed4113fe6..ba236c005 100644 --- a/docs/ibm_resource_instance.rst +++ b/docs/ibm_resource_instance.rst @@ -31,40 +31,40 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - parameters (False, dict, None) - Arbitrary parameters to pass. Must be a JSON object + name (True, str, None) + (Required for new resource) A name for the resource instance - location (True, str, None) - (Required for new resource) The location where the instance available + plan (True, str, None) + (Required for new resource) The plan type of the service - tags (False, list, None) - None + service (True, str, None) + (Required for new resource) The name of the service offering like cloud-object-storage, kms etc - service_endpoints (False, str, None) - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. + resource_group_id (False, str, None) + The resource group id - name (True, str, None) - (Required for new resource) A name for the resource instance + parameters (False, dict, None) + Arbitrary parameters to pass. Must be a JSON object - service (True, str, None) - (Required for new resource) The name of the service offering like cloud-object-storage, kms etc + parameters_json (False, str, None) + Arbitrary parameters to pass in Json string format - plan (True, str, None) - (Required for new resource) The plan type of the service + service_endpoints (False, str, None) + Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. - resource_group_id (False, str, None) - The resource group id + tags (False, list, None) + None - parameters_json (False, str, None) - Arbitrary parameters to pass in Json string format + location (True, str, None) + (Required for new resource) The location where the instance available id (False, str, None) diff --git a/docs/ibm_resource_instance_info.rst b/docs/ibm_resource_instance_info.rst index 020a5228a..f5ba77a11 100644 --- a/docs/ibm_resource_instance_info.rst +++ b/docs/ibm_resource_instance_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + name (True, str, None) + Resource instance name for example, myobjectstorage + + location (False, str, None) The location or the environment in which instance exists @@ -41,10 +45,6 @@ Parameters The id of the resource group in which the instance is present - name (True, str, None) - Resource instance name for example, myobjectstorage - - iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_resource_key.rst b/docs/ibm_resource_key.rst index eadc9b787..a5479a500 100644 --- a/docs/ibm_resource_key.rst +++ b/docs/ibm_resource_key.rst @@ -31,18 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - tags (False, list, None) - None - - - resource_instance_id (False, str, None) - The id of the resource instance for which to create resource key - - name (True, str, None) (Required for new resource) The name of the resource key + resource_alias_id (False, str, None) + The id of the resource alias for which to create resource key + + parameters (False, dict, None) Arbitrary parameters to pass. Must be a JSON object @@ -51,8 +47,12 @@ Parameters Name of the user role.Valid roles are Writer, Reader, Manager, Administrator, Operator, Viewer, Editor and Custom Roles. - resource_alias_id (False, str, None) - The id of the resource alias for which to create resource key + resource_instance_id (False, str, None) + The id of the resource instance for which to create resource key + + + tags (False, list, None) + None id (False, str, None) diff --git a/docs/ibm_resource_key_info.rst b/docs/ibm_resource_key_info.rst index 1dcf1dcb6..e3f5395ab 100644 --- a/docs/ibm_resource_key_info.rst +++ b/docs/ibm_resource_key_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + name (True, str, None) + The name of the resource key + + resource_instance_id (False, str, None) The id of the resource instance @@ -41,10 +45,6 @@ Parameters If true and multiple entries are found, the most recently created resource key is used. If false, an error is returned - name (True, str, None) - The name of the resource key - - iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_resource_tag_info.rst b/docs/ibm_resource_tag_info.rst index b734a26f3..3d61a6624 100644 --- a/docs/ibm_resource_tag_info.rst +++ b/docs/ibm_resource_tag_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + resource_type (False, str, None) + Resource type on which the tags should be fetched + + tag_type (False, str, user) Tag type on which the tags should be fetched @@ -37,10 +41,6 @@ Parameters CRN of the resource on which the tags should be attached - resource_type (False, str, None) - Resource type on which the tags should be fetched - - iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_satellite_attach_host_script_info.rst b/docs/ibm_satellite_attach_host_script_info.rst index cb1a6c61b..de527d245 100644 --- a/docs/ibm_satellite_attach_host_script_info.rst +++ b/docs/ibm_satellite_attach_host_script_info.rst @@ -29,10 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - location (True, str, None) - A unique name for the new Satellite location - - labels (False, list, None) List of labels for the attach host @@ -45,6 +41,10 @@ Parameters The directory where the satellite attach host script to be downloaded. Default is home directory + location (True, str, None) + A unique name for the new Satellite location + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_satellite_cluster_worker_pool.rst b/docs/ibm_satellite_cluster_worker_pool.rst index dfc744469..38b8ae08f 100644 --- a/docs/ibm_satellite_cluster_worker_pool.rst +++ b/docs/ibm_satellite_cluster_worker_pool.rst @@ -31,12 +31,24 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + flavor (False, str, None) + The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node + + + disk_encryption (False, bool, None) + Disk encryption for worker node + + + worker_count (False, int, None) + Specify the desired number of workers per zone in this worker pool + + zones (False, list, None) Zone info for worker pool - host_labels (False, list, None) - Labels that describe a Satellite host + resource_group_id (False, str, None) + ID of the resource group. name (True, str, None) @@ -47,22 +59,10 @@ Parameters (Required for new resource) The unique name for the new IBM Cloud Satellite cluster - flavor (False, str, None) - The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node - - - disk_encryption (False, bool, None) - Disk encryption for worker node - - isolation (False, str, None) None - worker_count (False, int, None) - Specify the desired number of workers per zone in this worker pool - - entitlement (False, str, None) None @@ -71,8 +71,8 @@ Parameters Labels on all the workers in the worker pool - resource_group_id (False, str, None) - ID of the resource group. + host_labels (False, list, None) + Labels that describe a Satellite host id (False, str, None) diff --git a/docs/ibm_satellite_cluster_worker_pool_info.rst b/docs/ibm_satellite_cluster_worker_pool_info.rst index e9b600baa..444f9278f 100644 --- a/docs/ibm_satellite_cluster_worker_pool_info.rst +++ b/docs/ibm_satellite_cluster_worker_pool_info.rst @@ -29,20 +29,20 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - region (False, any, us-south) - The IBM Cloud region where you want to create your resources. If this value is not specified, us-south is used by default. This can also be provided via the environment variable 'IC_REGION'. - - name (True, str, None) worker pool name + cluster (True, str, None) + Cluster name + + resource_group_id (False, str, None) ID of the resource group - cluster (True, str, None) - Cluster name + region (False, any, us-south) + The IBM Cloud region where you want to create your resources. If this value is not specified, us-south is used by default. This can also be provided via the environment variable 'IC_REGION'. iaas_classic_username (False, any, None) diff --git a/docs/ibm_satellite_cluster_worker_pool_zone_attachment_info.rst b/docs/ibm_satellite_cluster_worker_pool_zone_attachment_info.rst index 20fee8858..90fb000ae 100644 --- a/docs/ibm_satellite_cluster_worker_pool_zone_attachment_info.rst +++ b/docs/ibm_satellite_cluster_worker_pool_zone_attachment_info.rst @@ -29,14 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - zone (True, str, None) - worker pool zone name - - - resource_group_id (False, str, None) - The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method. - - cluster (True, str, None) Name or id of the cluster @@ -45,6 +37,14 @@ Parameters worker pool name + zone (True, str, None) + worker pool zone name + + + resource_group_id (False, str, None) + The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_satellite_endpoint.rst b/docs/ibm_satellite_endpoint.rst index b6aea6ffe..55f65ff79 100644 --- a/docs/ibm_satellite_endpoint.rst +++ b/docs/ibm_satellite_endpoint.rst @@ -31,8 +31,8 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - timeout (False, int, None) - The inactivity timeout in the Endpoint side. + server_mutual_auth (False, bool, False) + Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required. location (True, str, None) @@ -43,48 +43,48 @@ Parameters (Required for new resource) The type of the endpoint. - server_host (True, str, None) - (Required for new resource) The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '*.' , which means a wildcard to it's sub domains. Such as '*.example.com' can accept request to 'api.example.com' and 'www.example.com'. + display_name (True, str, None) + (Required for new resource) The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer. - server_port (True, int, None) - (Required for new resource) The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https). + sni (False, str, None) + The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI. - server_protocol (False, str, None) - The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'. + created_by (False, str, None) + The service or person who created the endpoint. Must be 1000 characters or fewer. - display_name (True, str, None) - (Required for new resource) The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer. + certs (False, list, None) + The certs. - server_mutual_auth (False, bool, False) - Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required. + client_protocol (True, str, None) + (Required for new resource) The protocol in the client application side. - reject_unauth (False, bool, False) - Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert. + client_mutual_auth (False, bool, False) + Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required. - created_by (False, str, None) - The service or person who created the endpoint. Must be 1000 characters or fewer. + reject_unauth (False, bool, False) + Whether reject any connection to the server application which is not authorized with the list of supplied CAs in the fields certs.server_cert. - client_mutual_auth (False, bool, False) - Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required. + server_host (True, str, None) + (Required for new resource) The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '*.' , which means a wildcard to it's sub domains. Such as '*.example.com' can accept request to 'api.example.com' and 'www.example.com'. - certs (False, list, None) - The certs. + server_port (True, int, None) + (Required for new resource) The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https). - sni (False, str, None) - The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI. + server_protocol (False, str, None) + The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'. - client_protocol (True, str, None) - (Required for new resource) The protocol in the client application side. + timeout (False, int, None) + The inactivity timeout in the Endpoint side. id (False, str, None) diff --git a/docs/ibm_satellite_endpoint_info.rst b/docs/ibm_satellite_endpoint_info.rst index 06c356da9..730c6ef91 100644 --- a/docs/ibm_satellite_endpoint_info.rst +++ b/docs/ibm_satellite_endpoint_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - location (True, str, None) - The Location ID. - - endpoint_id (True, str, None) The Endpoint ID. + location (True, str, None) + The Location ID. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_satellite_host.rst b/docs/ibm_satellite_host.rst index e4486ce9e..ac2dfb944 100644 --- a/docs/ibm_satellite_host.rst +++ b/docs/ibm_satellite_host.rst @@ -31,6 +31,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + zone (False, str, None) + The zone within the cluster to assign the host to + + + worker_pool (False, str, None) + The name or ID of the worker pool within the cluster to assign the host to + + host_provider (False, str, None) Host Provider @@ -51,14 +59,6 @@ Parameters List of labels for the host - zone (False, str, None) - The zone within the cluster to assign the host to - - - worker_pool (False, str, None) - The name or ID of the worker pool within the cluster to assign the host to - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_satellite_link.rst b/docs/ibm_satellite_link.rst index cb804395d..6582c0691 100644 --- a/docs/ibm_satellite_link.rst +++ b/docs/ibm_satellite_link.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - crn (True, str, None) - (Required for new resource) CRN of the Location. - - location (True, str, None) (Required for new resource) Location ID. @@ -43,6 +39,10 @@ Parameters The ws endpoint of the location. + crn (True, str, None) + (Required for new resource) CRN of the Location. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_satellite_location.rst b/docs/ibm_satellite_location.rst index d8582459c..f7d360a50 100644 --- a/docs/ibm_satellite_location.rst +++ b/docs/ibm_satellite_location.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + location (True, str, None) + (Required for new resource) A unique name for the new Satellite location + + managed_from (True, str, None) (Required for new resource) The IBM Cloud metro from which the Satellite location is managed @@ -39,28 +43,24 @@ Parameters The account ID for IBM Log Analysis with LogDNA log forwarding - description (False, str, None) - A description of the new Satellite location + cos_credentials (False, list, None) + COSAuthorization - IBM Cloud Object Storage authorization keys - cos_config (False, list, None) - COSBucket - IBM Cloud Object Storage bucket configuration details + tags (False, list, None) + List of tags associated with resource instance - cos_credentials (False, list, None) - COSAuthorization - IBM Cloud Object Storage authorization keys + description (False, str, None) + A description of the new Satellite location resource_group_id (False, str, None) ID of the resource group. - tags (False, list, None) - List of tags associated with resource instance - - - location (True, str, None) - (Required for new resource) A unique name for the new Satellite location + cos_config (False, list, None) + COSBucket - IBM Cloud Object Storage bucket configuration details zones (False, list, None) diff --git a/docs/ibm_scc_posture_collector.rst b/docs/ibm_scc_posture_collector.rst index abcebb435..498a9e8bb 100644 --- a/docs/ibm_scc_posture_collector.rst +++ b/docs/ibm_scc_posture_collector.rst @@ -31,18 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - is_public (True, bool, None) - (Required for new resource) Determines whether the collector endpoint is accessible on a public network. If set to `true`, the collector connects to resources in your account over a public network. If set to `false`, the collector connects to resources by using a private IP that is accessible only through the IBM Cloud private network. - - - managed_by (True, str, None) - (Required for new resource) Determines whether the collector is an IBM or customer-managed virtual machine. Use `ibm` to allow Security and Compliance Center to create, install, and manage the collector on your behalf. The collector is installed in an OpenShift cluster and approved automatically for use. Use `customer` if you would like to install the collector by using your own virtual machine. For more information, check out the [docs](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-collector). - - - description (False, str, None) - A detailed description of the collector. - - passphrase (False, str, None) To protect the credentials that you add to the service, a passphrase is used to generate a data encryption key. The key is used to securely store your credentials and prevent anyone from accessing them. @@ -55,6 +43,18 @@ Parameters (Required for new resource) A unique name for your collector. + is_public (True, bool, None) + (Required for new resource) Determines whether the collector endpoint is accessible on a public network. If set to `true`, the collector connects to resources in your account over a public network. If set to `false`, the collector connects to resources by using a private IP that is accessible only through the IBM Cloud private network. + + + managed_by (True, str, None) + (Required for new resource) Determines whether the collector is an IBM or customer-managed virtual machine. Use `ibm` to allow Security and Compliance Center to create, install, and manage the collector on your behalf. The collector is installed in an OpenShift cluster and approved automatically for use. Use `customer` if you would like to install the collector by using your own virtual machine. For more information, check out the [docs](https://cloud.ibm.com/docs/security-compliance?topic=security-compliance-collector). + + + description (False, str, None) + A detailed description of the collector. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_scc_posture_credential.rst b/docs/ibm_scc_posture_credential.rst index 4374dcf13..a847a2b64 100644 --- a/docs/ibm_scc_posture_credential.rst +++ b/docs/ibm_scc_posture_credential.rst @@ -31,18 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - display_fields (True, list, None) - (Required for new resource) Details the fields on the credential. This will change as per credential type selected. - - - group (True, list, None) - (Required for new resource) Credential group details. - - - purpose (True, str, None) - (Required for new resource) Purpose for which the credential is created. - - enabled (True, bool, None) (Required for new resource) Credentials status enabled/disbaled. @@ -59,6 +47,18 @@ Parameters (Required for new resource) Credentials description. + display_fields (True, list, None) + (Required for new resource) Details the fields on the credential. This will change as per credential type selected. + + + group (True, list, None) + (Required for new resource) Credential group details. + + + purpose (True, str, None) + (Required for new resource) Purpose for which the credential is created. + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_scc_posture_scope.rst b/docs/ibm_scc_posture_scope.rst index c9a3e4e20..89fdd3213 100644 --- a/docs/ibm_scc_posture_scope.rst +++ b/docs/ibm_scc_posture_scope.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + credential_type (True, str, None) + (Required for new resource) The environment that the scope is targeted to. + + name (True, str, None) (Required for new resource) A unique name for your scope. @@ -47,10 +51,6 @@ Parameters (Required for new resource) The unique identifier of the credential. - credential_type (True, str, None) - (Required for new resource) The environment that the scope is targeted to. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_scc_si_providers_info.rst b/docs/ibm_scc_si_providers_info.rst index b48bcbacb..06a85742e 100644 --- a/docs/ibm_scc_si_providers_info.rst +++ b/docs/ibm_scc_si_providers_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + account_id (False, str, None) + None + + limit (False, int, None) The number of elements returned in the current instance. The default is 200. @@ -37,10 +41,6 @@ Parameters The offset is the index of the item from which you want to start returning data from. The default is 0. - account_id (False, str, None) - None - - iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_schematics_inventory.rst b/docs/ibm_schematics_inventory.rst index 7528c211d..f5146155e 100644 --- a/docs/ibm_schematics_inventory.rst +++ b/docs/ibm_schematics_inventory.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - location (False, str, None) - List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. - - - resource_group (False, str, None) - Resource-group name for the Inventory definition. By default, Inventory definition will be created in Default Resource Group. - - name (False, str, None) The unique name of your Inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. @@ -47,6 +39,14 @@ Parameters The description of your Inventory definition. The description can be up to 2048 characters long in size. + resource_group (False, str, None) + Resource-group name for the Inventory definition. By default, Inventory definition will be created in Default Resource Group. + + + location (False, str, None) + List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. + + inventories_ini (False, str, None) Input inventory of host and host group for the playbook, in the `.ini` file format. diff --git a/docs/ibm_schematics_job.rst b/docs/ibm_schematics_job.rst index 57bef2b78..4bb951f8e 100644 --- a/docs/ibm_schematics_job.rst +++ b/docs/ibm_schematics_job.rst @@ -31,16 +31,16 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - command_object_id (True, str, None) - (Required for new resource) Job command object id (workspace-id, action-id). + location (False, str, None) + List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. - command_name (True, str, None) - (Required for new resource) Schematics job command name. + data (False, list, None) + Job data. - job_inputs (False, list, None) - Job inputs used by Action or Workspace. + bastion (False, list, None) + Describes a bastion resource. log_summary (False, list, None) @@ -51,32 +51,32 @@ Parameters (Required for new resource) Name of the Schematics automation resource. - job_env_settings (False, list, None) - Environment variables used by the Job while performing Action or Workspace. - - - command_parameter (False, str, None) - Schematics job command parameter (playbook-name). + command_object_id (True, str, None) + (Required for new resource) Job command object id (workspace-id, action-id). - tags (False, list, None) - User defined tags, while running the job. + command_name (True, str, None) + (Required for new resource) Schematics job command name. - bastion (False, list, None) - Describes a bastion resource. + command_parameter (False, str, None) + Schematics job command parameter (playbook-name). command_options (False, list, None) Command line options for the command. - location (False, str, None) - List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. + tags (False, list, None) + User defined tags, while running the job. - data (False, list, None) - Job data. + job_inputs (False, list, None) + Job inputs used by Action or Workspace. + + + job_env_settings (False, list, None) + Environment variables used by the Job while performing Action or Workspace. id (False, str, None) diff --git a/docs/ibm_schematics_output_info.rst b/docs/ibm_schematics_output_info.rst index ebec12373..a858d1548 100644 --- a/docs/ibm_schematics_output_info.rst +++ b/docs/ibm_schematics_output_info.rst @@ -29,6 +29,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + output_json (False, str, None) + The json output in string + + workspace_id (True, str, None) The ID of the workspace for which you want to retrieve output values. To find the workspace ID, use the `GET /workspaces` API. @@ -37,10 +41,6 @@ Parameters The id of template - output_json (False, str, None) - The json output in string - - iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_schematics_resource_query.rst b/docs/ibm_schematics_resource_query.rst index b1fab8092..611706782 100644 --- a/docs/ibm_schematics_resource_query.rst +++ b/docs/ibm_schematics_resource_query.rst @@ -31,10 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - type (False, str, None) - Resource type (cluster, vsi, icd, vpc). - - name (False, str, None) Resource query name. @@ -43,6 +39,10 @@ Parameters None + type (False, str, None) + Resource type (cluster, vsi, icd, vpc). + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_schematics_workspace_info.rst b/docs/ibm_schematics_workspace_info.rst index 354e1bee2..f64f0a391 100644 --- a/docs/ibm_schematics_workspace_info.rst +++ b/docs/ibm_schematics_workspace_info.rst @@ -33,14 +33,14 @@ Parameters The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. - template_values_metadata (False, list, None) - A list of input variables that are associated with the workspace. - - template_git_has_uploadedgitrepotar (False, bool, None) Has uploaded Git repository tar. + template_values_metadata (False, list, None) + A list of input variables that are associated with the workspace. + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_security_group_info.rst b/docs/ibm_security_group_info.rst index d14592591..1fe82111a 100644 --- a/docs/ibm_security_group_info.rst +++ b/docs/ibm_security_group_info.rst @@ -29,10 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - description (False, str, None) - The description of the security group - - most_recent (False, bool, False) If true and multiple entries are found, the most recently created group is used. If false, an error is returned @@ -41,6 +37,10 @@ Parameters The name of the security group + description (False, str, None) + The description of the security group + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_service_instance.rst b/docs/ibm_service_instance.rst index 2d4453cd4..3e55eaea5 100644 --- a/docs/ibm_service_instance.rst +++ b/docs/ibm_service_instance.rst @@ -31,14 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - parameters (False, dict, None) - Arbitrary parameters to pass along to the service broker. Must be a JSON object - - - tags (False, list, None) - None - - wait_time_minutes (False, int, 10) Define timeout to wait for the service instances to succeeded/deleted etc. @@ -47,18 +39,26 @@ Parameters (Required for new resource) A name for the service instance - space_guid (True, str, None) - (Required for new resource) The guid of the space in which the instance will be created - - service (True, str, None) (Required for new resource) The name of the service offering like speech_to_text, text_to_speech etc + tags (False, list, None) + None + + plan (True, str, None) (Required for new resource) The plan type of the service + space_guid (True, str, None) + (Required for new resource) The guid of the space in which the instance will be created + + + parameters (False, dict, None) + Arbitrary parameters to pass along to the service broker. Must be a JSON object + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_service_instance_info.rst b/docs/ibm_service_instance_info.rst index da77af813..ffa5d94df 100644 --- a/docs/ibm_service_instance_info.rst +++ b/docs/ibm_service_instance_info.rst @@ -29,14 +29,14 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - Service instance name for example, speech_to_text - - space_guid (True, str, None) The guid of the space in which the instance is present + name (True, str, None) + Service instance name for example, speech_to_text + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_service_key_info.rst b/docs/ibm_service_key_info.rst index 5368ef186..b71668a67 100644 --- a/docs/ibm_service_key_info.rst +++ b/docs/ibm_service_key_info.rst @@ -29,10 +29,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - name (True, str, None) - The name of the service key - - service_instance_name (True, str, None) Service instance name for example, speech_to_text @@ -41,6 +37,10 @@ Parameters The guid of the space in which the service instance is present + name (True, str, None) + The name of the service key + + iaas_classic_username (False, any, None) (Required when generation = 1) The IBM Cloud Classic Infrastructure (SoftLayer) user name. This can also be provided via the environment variable 'IAAS_CLASSIC_USERNAME'. diff --git a/docs/ibm_space.rst b/docs/ibm_space.rst index a865bb456..0e01ca5cb 100644 --- a/docs/ibm_space.rst +++ b/docs/ibm_space.rst @@ -31,18 +31,6 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - managers (False, list, None) - The IBMID of the users who will have manager role in this space, ex - user@example.com - - - developers (False, list, None) - The IBMID of the users who will have developer role in this space, ex - user@example.com - - - space_quota (False, str, None) - The name of the Space Quota Definition - - tags (False, list, None) None @@ -59,6 +47,18 @@ Parameters The IBMID of the users who will have auditor role in this space, ex - user@example.com + managers (False, list, None) + The IBMID of the users who will have manager role in this space, ex - user@example.com + + + developers (False, list, None) + The IBMID of the users who will have developer role in this space, ex - user@example.com + + + space_quota (False, str, None) + The name of the Space Quota Definition + + id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_ssl_certificate.rst b/docs/ibm_ssl_certificate.rst index 4b5017c21..a37b840b4 100644 --- a/docs/ibm_ssl_certificate.rst +++ b/docs/ibm_ssl_certificate.rst @@ -31,68 +31,68 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - validity_months (True, int, None) - (Required for new resource) vslidity of the ssl certificate in month - - - certificate_signing_request (True, str, None) - (Required for new resource) certificate signing request info + billing_contact_same_as_technical_flag (False, bool, False) + billing contact administrative_contact (False, list, None) None - billing_contact (False, list, None) - None + organization_information (True, list, None) + (Required for new resource) Organization information - order_approver_email_address (True, str, None) - (Required for new resource) Email address of the approver + server_count (True, int, None) + (Required for new resource) Server count technical_contact_same_as_org_address_flag (False, bool, False) Technical contact same as org address flag - billing_address_same_as_organization_flag (False, bool, False) - billing address same as organization flag + renewal_flag (False, bool, True) + Renewal flag - technical_contact (True, list, None) - (Required for new resource) Technical contact info + order_approver_email_address (True, str, None) + (Required for new resource) Email address of the approver - ssl_type (True, str, None) - (Required for new resource) ssl type + billing_address_same_as_organization_flag (False, bool, False) + billing address same as organization flag - renewal_flag (False, bool, True) - Renewal flag + ssl_type (True, str, None) + (Required for new resource) ssl type - organization_information (True, list, None) - (Required for new resource) Organization information + certificate_signing_request (True, str, None) + (Required for new resource) certificate signing request info - billing_contact_same_as_technical_flag (False, bool, False) - billing contact + administrative_contact_same_as_technical_flag (False, bool, False) + Administrative contact same as technical flag administrative_address_same_as_organization_flag (False, bool, False) administrative address same as organization flag - server_count (True, int, None) - (Required for new resource) Server count + technical_contact (True, list, None) + (Required for new resource) Technical contact info + + + billing_contact (False, list, None) + None server_type (True, str, None) (Required for new resource) server type - administrative_contact_same_as_technical_flag (False, bool, False) - Administrative contact same as technical flag + validity_months (True, int, None) + (Required for new resource) vslidity of the ssl certificate in month id (False, str, None) diff --git a/docs/ibm_storage_block.rst b/docs/ibm_storage_block.rst index 7e1588fb6..02541331e 100644 --- a/docs/ibm_storage_block.rst +++ b/docs/ibm_storage_block.rst @@ -31,52 +31,52 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - snapshot_capacity (False, int, None) - Snapshot capacity in GB - - - allowed_hardware_ids (False, list, None) - List of allowe hardware IDs - - allowed_virtual_guest_ids (False, list, None) List of allowed virtual guest IDs - tags (False, list, None) - List of tags associated with the resource + notes (False, str, None) + Additional note info type (True, str, None) (Required for new resource) Storage block type - iops (True, float, None) - (Required for new resource) IOPS value required + snapshot_capacity (False, int, None) + Snapshot capacity in GB + + + hourly_billing (False, bool, False) + Billing done hourly, if set to true + + + capacity (True, int, None) + (Required for new resource) Storage block size allowed_ip_addresses (False, list, None) Allowed IP addresses - hourly_billing (False, bool, False) - Billing done hourly, if set to true + allowed_hardware_ids (False, list, None) + List of allowe hardware IDs - datacenter (True, str, None) - (Required for new resource) Datacenter name + tags (False, list, None) + List of tags associated with the resource - capacity (True, int, None) - (Required for new resource) Storage block size + datacenter (True, str, None) + (Required for new resource) Datacenter name os_format_type (True, str, None) (Required for new resource) OS formatr type - notes (False, str, None) - Additional note info + iops (True, float, None) + (Required for new resource) IOPS value required id (False, str, None) diff --git a/docs/ibm_storage_evault.rst b/docs/ibm_storage_evault.rst index 9935622cb..2e0395d99 100644 --- a/docs/ibm_storage_evault.rst +++ b/docs/ibm_storage_evault.rst @@ -31,6 +31,10 @@ The below requirements are needed on the host that executes this module. Parameters ---------- + tags (False, list, None) + Tags set for the resource + + datacenter (True, str, None) (Required for new resource) Datacenter name @@ -47,10 +51,6 @@ Parameters Hardware instance ID - tags (False, list, None) - Tags set for the resource - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_storage_file.rst b/docs/ibm_storage_file.rst index d3d48aaf6..50a02e2ef 100644 --- a/docs/ibm_storage_file.rst +++ b/docs/ibm_storage_file.rst @@ -31,24 +31,20 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - datacenter (True, str, None) - (Required for new resource) Datacenter name - - - capacity (True, int, None) - (Required for new resource) Storage capacity + type (True, str, None) + (Required for new resource) Storage type - allowed_virtual_guest_ids (False, list, None) - Virtual guest ID + snapshot_capacity (False, int, None) + Snapshot capacity - allowed_hardware_ids (False, list, None) - Hardaware ID + notes (False, str, None) + Notes - iops (True, float, None) - (Required for new resource) iops rate + capacity (True, int, None) + (Required for new resource) Storage capacity allowed_subnets (False, list, None) @@ -59,10 +55,6 @@ Parameters Allowed range of IP addresses - notes (False, str, None) - Notes - - snapshot_schedule (False, list, None) None @@ -71,12 +63,20 @@ Parameters Tags set for the storage volume - type (True, str, None) - (Required for new resource) Storage type + datacenter (True, str, None) + (Required for new resource) Datacenter name - snapshot_capacity (False, int, None) - Snapshot capacity + iops (True, float, None) + (Required for new resource) iops rate + + + allowed_virtual_guest_ids (False, list, None) + Virtual guest ID + + + allowed_hardware_ids (False, list, None) + Hardaware ID hourly_billing (False, bool, False) diff --git a/docs/ibm_subnet.rst b/docs/ibm_subnet.rst index 032257fd7..d68a356ba 100644 --- a/docs/ibm_subnet.rst +++ b/docs/ibm_subnet.rst @@ -31,20 +31,20 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - type (True, str, None) - (Required for new resource) subnet type + private (False, bool, False) + private subnet - vlan_id (False, int, None) - VLAN ID for the subnet + type (True, str, None) + (Required for new resource) subnet type notes (False, str, None) Notes - private (False, bool, False) - private subnet + tags (False, list, None) + tags set for the resource ip_version (False, int, 4) @@ -55,12 +55,12 @@ Parameters (Required for new resource) number of ip addresses in the subnet - endpoint_ip (False, str, None) - endpoint IP + vlan_id (False, int, None) + VLAN ID for the subnet - tags (False, list, None) - tags set for the resource + endpoint_ip (False, str, None) + endpoint IP id (False, str, None) diff --git a/docs/ibm_tg_connection.rst b/docs/ibm_tg_connection.rst index 071c6386b..a72b960b0 100644 --- a/docs/ibm_tg_connection.rst +++ b/docs/ibm_tg_connection.rst @@ -31,26 +31,42 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - remote_bgp_asn (False, int, None) - The remote network BGP ASN. This field only applies to network type 'gre_tunnel' connections. + network_type (True, str, None) + (Required for new resource) Defines what type of network is connected via this connection. Allowable values (classic,directlink,vpc,gre_tunnel) + + + base_connection_id (False, str, None) + The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type 'gre_tunnel' connections. + + + local_tunnel_ip (False, str, None) + The local tunnel IP address. This field only applies to network type 'gre_tunnel' connections. remote_tunnel_ip (False, str, None) The remote tunnel IP address. This field only applies to network type 'gre_tunnel' connections. - local_gateway_ip (False, str, None) - The local gateway IP address. This field only applies to network type 'gre_tunnel' connections. + network_id (False, str, None) + The ID of the network being connected via this connection. This field is required for some types, such as 'vpc' or 'directlink'. The value of this is the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type 'classic'. - network_type (True, str, None) - (Required for new resource) Defines what type of network is connected via this connection. Allowable values (classic,directlink,vpc,gre_tunnel) + remote_bgp_asn (False, int, None) + The remote network BGP ASN. This field only applies to network type 'gre_tunnel' connections. name (False, str, None) The user-defined name for this transit gateway. If unspecified, the name will be the network name (the name of the VPC in the case of network type 'vpc', and the word Classic, in the case of network type 'classic'). + network_account_id (False, str, None) + The ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. + + + local_gateway_ip (False, str, None) + The local gateway IP address. This field only applies to network type 'gre_tunnel' connections. + + zone (False, str, None) Location of GRE tunnel. This field only applies to network type 'gre_tunnel' connections. @@ -63,22 +79,6 @@ Parameters The remote gateway IP address. This field only applies to network type 'gre_tunnel' connections. - network_id (False, str, None) - The ID of the network being connected via this connection. This field is required for some types, such as 'vpc' or 'directlink'. The value of this is the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type 'classic'. - - - network_account_id (False, str, None) - The ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. - - - base_connection_id (False, str, None) - The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type 'gre_tunnel' connections. - - - local_tunnel_ip (False, str, None) - The local tunnel IP address. This field only applies to network type 'gre_tunnel' connections. - - id (False, str, None) (Required when updating or destroying existing resource) IBM Cloud Resource ID. diff --git a/docs/ibm_tg_gateway.rst b/docs/ibm_tg_gateway.rst index 20f268046..46d7db976 100644 --- a/docs/ibm_tg_gateway.rst +++ b/docs/ibm_tg_gateway.rst @@ -31,22 +31,22 @@ The below requirements are needed on the host that executes this module. Parameters ---------- - location (True, str, None) - (Required for new resource) Location of Transit Gateway Services - - - global_ (False, bool, False) - Allow global routing for a Transit Gateway. If unspecified, the default value is false - - tags (False, list, None) Tags for the transit gateway instance + location (True, str, None) + (Required for new resource) Location of Transit Gateway Services + + name (True, str, None) (Required for new resource) Name Transit Gateway Services + global_ (False, bool, False) + Allow global routing for a Transit Gateway. If unspecified, the default value is false + + resource_group (False, str, None) None diff --git a/galaxy.yml b/galaxy.yml index 774b7129c..4e577bee0 100644 --- a/galaxy.yml +++ b/galaxy.yml @@ -1,6 +1,6 @@ namespace: "ibm" name: "cloudcollection" -version: "1.38.2" +version: "1.38.3" readme: "README.md" authors: - "Jay W Carman" diff --git a/plugins/modules/ibm_api_gateway_endpoint.py b/plugins/modules/ibm_api_gateway_endpoint.py index 7c685f036..805cf131a 100644 --- a/plugins/modules/ibm_api_gateway_endpoint.py +++ b/plugins/modules/ibm_api_gateway_endpoint.py @@ -22,17 +22,11 @@ - Terraform v0.12.20 options: - open_api_doc_name: + service_instance_crn: description: - - (Required for new resource) Json File path + - (Required for new resource) Api Gateway Service Instance Crn required: True type: str - routes: - description: - - Invokable routes for an endpoint - required: False - type: list - elements: str managed: description: - Managed indicates if endpoint is online or offline. @@ -45,9 +39,15 @@ required: False type: str default: unshare - service_instance_crn: + provider_id: description: - - (Required for new resource) Api Gateway Service Instance Crn + - Provider ID of an endpoint allowable values user-defined and whisk + required: False + type: str + default: user-defined + open_api_doc_name: + description: + - (Required for new resource) Json File path required: True type: str name: @@ -55,12 +55,12 @@ - (Required for new resource) Endpoint name required: True type: str - provider_id: + routes: description: - - Provider ID of an endpoint allowable values user-defined and whisk + - Invokable routes for an endpoint required: False - type: str - default: user-defined + type: list + elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -107,20 +107,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('open_api_doc_name', 'str'), ('service_instance_crn', 'str'), + ('open_api_doc_name', 'str'), ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'open_api_doc_name', - 'routes', + 'service_instance_crn', 'managed', 'type', - 'service_instance_crn', - 'name', 'provider_id', + 'open_api_doc_name', + 'name', + 'routes', ] # Params for Data source @@ -137,28 +137,28 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - open_api_doc_name=dict( + service_instance_crn=dict( required=False, type='str'), - routes=dict( - required=False, - elements='', - type='list'), managed=dict( required=False, type='bool'), type=dict( required=False, type='str'), - service_instance_crn=dict( + provider_id=dict( required=False, type='str'), - name=dict( + open_api_doc_name=dict( required=False, type='str'), - provider_id=dict( + name=dict( required=False, type='str'), + routes=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_app.py b/plugins/modules/ibm_app.py index 478f46dca..43a971141 100644 --- a/plugins/modules/ibm_app.py +++ b/plugins/modules/ibm_app.py @@ -22,94 +22,94 @@ - Terraform v0.12.20 options: - disk_quota: + memory: description: - - The maximum amount of disk available to an instance of an app. In megabytes. + - The amount of memory each instance should have. In megabytes. required: False type: int - environment_json: + instances: description: - - Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables. + - The number of instances required: False - type: dict - route_guid: + type: int + default: 1 + service_instance_guid: description: - - Define the route guids which should be bound to the application. + - Define the service instance guids that should be bound to this application. required: False type: list elements: str - instances: + app_version: description: - - The number of instances + - Version of the application required: False - type: int - default: 1 - space_guid: - description: - - (Required for new resource) Define space guid to which app belongs - required: True type: str - health_check_type: + command: description: - - Type of health check to perform. + - The initial command for the app required: False type: str - default: port - name: + health_check_http_endpoint: description: - - (Required for new resource) The name for the app - required: True + - Endpoint called to determine if the app is healthy. + required: False type: str - buildpack: + route_guid: description: - - Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack. + - Define the route guids which should be bound to the application. required: False - type: str + type: list + elements: str app_path: description: - (Required for new resource) Define the path of the zip file of the application. required: True type: str - app_version: + health_check_type: description: - - Version of the application + - Type of health check to perform. required: False type: str - wait_time_minutes: + default: port + disk_quota: description: - - Define timeout to wait for the app instances to start/update/restage etc. + - The maximum amount of disk available to an instance of an app. In megabytes. required: False type: int - default: 20 - memory: + buildpack: description: - - The amount of memory each instance should have. In megabytes. + - Buildpack to build the app. 3 options: a) Blank means autodetection; b) A Git Url pointing to a buildpack; c) Name of an installed buildpack. required: False - type: int - command: + type: str + health_check_timeout: description: - - The initial command for the app + - Timeout in seconds for health checking of an staged app when starting up. required: False + type: int + name: + description: + - (Required for new resource) The name for the app + required: True type: str - tags: + space_guid: description: - - None - required: False - type: list - elements: str - health_check_http_endpoint: + - (Required for new resource) Define space guid to which app belongs + required: True + type: str + environment_json: description: - - Endpoint called to determine if the app is healthy. + - Key/value pairs of all the environment variables to run in your app. Does not include any system or service variables. required: False - type: str - health_check_timeout: + type: dict + wait_time_minutes: description: - - Timeout in seconds for health checking of an staged app when starting up. + - Define timeout to wait for the app instances to start/update/restage etc. required: False type: int - service_instance_guid: + default: 20 + tags: description: - - Define the service instance guids that should be bound to this application. + - None required: False type: list elements: str @@ -159,30 +159,30 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('space_guid', 'str'), - ('name', 'str'), ('app_path', 'str'), + ('name', 'str'), + ('space_guid', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'disk_quota', - 'environment_json', - 'route_guid', + 'memory', 'instances', - 'space_guid', - 'health_check_type', - 'name', - 'buildpack', - 'app_path', + 'service_instance_guid', 'app_version', - 'wait_time_minutes', - 'memory', 'command', - 'tags', 'health_check_http_endpoint', + 'route_guid', + 'app_path', + 'health_check_type', + 'disk_quota', + 'buildpack', 'health_check_timeout', - 'service_instance_guid', + 'name', + 'space_guid', + 'environment_json', + 'wait_time_minutes', + 'tags', ] # Params for Data source @@ -203,57 +203,57 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - disk_quota=dict( + memory=dict( required=False, type='int'), - environment_json=dict( + instances=dict( required=False, - type='dict'), - route_guid=dict( + type='int'), + service_instance_guid=dict( required=False, elements='', type='list'), - instances=dict( - required=False, - type='int'), - space_guid=dict( + app_version=dict( required=False, type='str'), - health_check_type=dict( + command=dict( required=False, type='str'), - name=dict( + health_check_http_endpoint=dict( required=False, type='str'), - buildpack=dict( + route_guid=dict( required=False, - type='str'), + elements='', + type='list'), app_path=dict( required=False, type='str'), - app_version=dict( + health_check_type=dict( required=False, type='str'), - wait_time_minutes=dict( + disk_quota=dict( required=False, type='int'), - memory=dict( + buildpack=dict( + required=False, + type='str'), + health_check_timeout=dict( required=False, type='int'), - command=dict( + name=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), - health_check_http_endpoint=dict( + space_guid=dict( required=False, type='str'), - health_check_timeout=dict( + environment_json=dict( + required=False, + type='dict'), + wait_time_minutes=dict( required=False, type='int'), - service_instance_guid=dict( + tags=dict( required=False, elements='', type='list'), diff --git a/plugins/modules/ibm_app_config_environment.py b/plugins/modules/ibm_app_config_environment.py index 26371e945..866901489 100644 --- a/plugins/modules/ibm_app_config_environment.py +++ b/plugins/modules/ibm_app_config_environment.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + environment_id: + description: + - (Required for new resource) Environment Id. + required: True + type: str color_code: description: - Color code to distinguish the environment. @@ -32,11 +37,6 @@ - (Required for new resource) Environment name. required: True type: str - environment_id: - description: - - (Required for new resource) Environment Id. - required: True - type: str description: description: - Environment description @@ -98,16 +98,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('environment_id', 'str'), + ('name', 'str'), ('guid', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'environment_id', 'color_code', 'name', - 'environment_id', 'description', 'tags', 'guid', @@ -121,8 +121,8 @@ TL_ALL_PARAMETERS_DS = [ 'guid', - 'expand', 'environment_id', + 'expand', ] TL_CONFLICTS_MAP = { @@ -132,13 +132,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - color_code=dict( + environment_id=dict( required=False, type='str'), - name=dict( + color_code=dict( required=False, type='str'), - environment_id=dict( + name=dict( required=False, type='str'), description=dict( diff --git a/plugins/modules/ibm_app_config_environment_info.py b/plugins/modules/ibm_app_config_environment_info.py index fecc2f05a..c3128a5db 100644 --- a/plugins/modules/ibm_app_config_environment_info.py +++ b/plugins/modules/ibm_app_config_environment_info.py @@ -26,16 +26,16 @@ - GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. required: True type: str - expand: - description: - - If set to `true`, returns expanded view of the resource details. - required: False - type: bool environment_id: description: - Environment Id. required: True type: str + expand: + description: + - If set to `true`, returns expanded view of the resource details. + required: False + type: bool iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -76,8 +76,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'guid', - 'expand', 'environment_id', + 'expand', ] @@ -91,12 +91,12 @@ guid=dict( required=True, type='str'), - expand=dict( - required=False, - type='bool'), environment_id=dict( required=True, type='str'), + expand=dict( + required=False, + type='bool'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_app_config_environments_info.py b/plugins/modules/ibm_app_config_environments_info.py index ade1f03f5..78babfea0 100644 --- a/plugins/modules/ibm_app_config_environments_info.py +++ b/plugins/modules/ibm_app_config_environments_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + tags: + description: + - filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags. + required: False + type: str limit: description: - The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records. @@ -36,11 +41,6 @@ - If set to `true`, returns expanded view of the resource details. required: False type: bool - tags: - description: - - filter the resources to be returned based on the associated tags. Returns resources associated with any of the specified tags. - required: False - type: str offset: description: - The number of records to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset` value. Use `offset` with `limit` to page through the available records. @@ -84,10 +84,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'tags', 'limit', 'guid', 'expand', - 'tags', 'offset', ] @@ -99,6 +99,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + tags=dict( + required=False, + type='str'), limit=dict( required=False, type='int'), @@ -108,9 +111,6 @@ expand=dict( required=False, type='bool'), - tags=dict( - required=False, - type='str'), offset=dict( required=False, type='int'), diff --git a/plugins/modules/ibm_app_config_feature.py b/plugins/modules/ibm_app_config_feature.py index ddb63b633..81f1f8220 100644 --- a/plugins/modules/ibm_app_config_feature.py +++ b/plugins/modules/ibm_app_config_feature.py @@ -22,63 +22,63 @@ - Terraform v0.12.20 options: - segment_rules: - description: - - Specify the targeting rules that is used to set different feature flag values for different segments. - required: False - type: list - elements: dict - collections: - description: - - List of collection id representing the collections that are associated with the specified feature flag. - required: False - type: list - elements: dict - type: + guid: description: - - (Required for new resource) Type of the feature (BOOLEAN, STRING, NUMERIC). + - (Required for new resource) GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. required: True type: str - enabled_value: + environment_id: description: - - (Required for new resource) Value of the feature when it is enabled. The value can be BOOLEAN, STRING or a NUMERIC value as per the `type` attribute. + - (Required for new resource) Environment Id. required: True type: str - description: - description: - - Feature description. - required: False - type: str tags: description: - Tags associated with the feature. required: False type: str - environment_id: + feature_id: description: - - (Required for new resource) Environment Id. + - (Required for new resource) Feature id. required: True type: str + type: + description: + - (Required for new resource) Type of the feature (BOOLEAN, STRING, NUMERIC). + required: True + type: str + description: + description: + - Feature description. + required: False + type: str name: description: - (Required for new resource) Feature name. required: True type: str - feature_id: + enabled_value: description: - - (Required for new resource) Feature id. + - (Required for new resource) Value of the feature when it is enabled. The value can be BOOLEAN, STRING or a NUMERIC value as per the `type` attribute. required: True type: str + segment_rules: + description: + - Specify the targeting rules that is used to set different feature flag values for different segments. + required: False + type: list + elements: dict + collections: + description: + - List of collection id representing the collections that are associated with the specified feature flag. + required: False + type: list + elements: dict disabled_value: description: - (Required for new resource) Value of the feature when it is disabled. The value can be BOOLEAN, STRING or a NUMERIC value as per the `type` attribute. required: True type: str - guid: - description: - - (Required for new resource) GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -125,42 +125,42 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('type', 'str'), - ('enabled_value', 'str'), + ('guid', 'str'), ('environment_id', 'str'), - ('name', 'str'), ('feature_id', 'str'), + ('type', 'str'), + ('name', 'str'), + ('enabled_value', 'str'), ('disabled_value', 'str'), - ('guid', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'segment_rules', - 'collections', + 'guid', + 'environment_id', + 'tags', + 'feature_id', 'type', - 'enabled_value', 'description', - 'tags', - 'environment_id', 'name', - 'feature_id', + 'enabled_value', + 'segment_rules', + 'collections', 'disabled_value', - 'guid', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('environment_id', 'str'), ('guid', 'str'), ('feature_id', 'str'), + ('environment_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'environment_id', 'guid', 'feature_id', 'includes', + 'environment_id', ] TL_CONFLICTS_MAP = { @@ -170,39 +170,39 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - segment_rules=dict( - required=False, - elements='', - type='list'), - collections=dict( + guid=dict( required=False, - elements='', - type='list'), - type=dict( + type='str'), + environment_id=dict( required=False, type='str'), - enabled_value=dict( + tags=dict( required=False, type='str'), - description=dict( + feature_id=dict( required=False, type='str'), - tags=dict( + type=dict( required=False, type='str'), - environment_id=dict( + description=dict( required=False, type='str'), name=dict( required=False, type='str'), - feature_id=dict( + enabled_value=dict( required=False, type='str'), - disabled_value=dict( + segment_rules=dict( required=False, - type='str'), - guid=dict( + elements='', + type='list'), + collections=dict( + required=False, + elements='', + type='list'), + disabled_value=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_app_config_feature_info.py b/plugins/modules/ibm_app_config_feature_info.py index 73ae514be..617148e58 100644 --- a/plugins/modules/ibm_app_config_feature_info.py +++ b/plugins/modules/ibm_app_config_feature_info.py @@ -21,11 +21,6 @@ - Terraform v0.12.20 options: - environment_id: - description: - - Environment Id. - required: True - type: str guid: description: - GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. @@ -41,6 +36,11 @@ - Include the associated collections in the response. required: False type: str + environment_id: + description: + - Environment Id. + required: True + type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -74,17 +74,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('environment_id', 'str'), ('guid', 'str'), ('feature_id', 'str'), + ('environment_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'environment_id', 'guid', 'feature_id', 'includes', + 'environment_id', ] @@ -95,9 +95,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - environment_id=dict( - required=True, - type='str'), guid=dict( required=True, type='str'), @@ -107,6 +104,9 @@ includes=dict( required=False, type='str'), + environment_id=dict( + required=True, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_app_config_features_info.py b/plugins/modules/ibm_app_config_features_info.py index b0066f4be..bc771dbaa 100644 --- a/plugins/modules/ibm_app_config_features_info.py +++ b/plugins/modules/ibm_app_config_features_info.py @@ -21,11 +21,6 @@ - Terraform v0.12.20 options: - guid: - description: - - GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. - required: True - type: str collections: description: - Filter features by a list of comma separated collections. @@ -37,43 +32,48 @@ - If set to `true`, returns expanded view of the resource details. required: False type: bool - limit: - description: - - The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records. - required: False - type: int offset: description: - The number of records to skip. By specifying `offset`, you retrieve a subset of items that starts with the `offset` value. Use `offset` with `limit` to page through the available records. required: False type: int - tags: + guid: description: - - Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags. - required: False + - GUID of the App Configuration service. Get it from the service instance credentials section of the dashboard. + required: True type: str environment_id: description: - Environment Id. required: True type: str - sort: + segments: description: - - Sort the feature details based on the specified attribute. + - Filter features by a list of comma separated segments. required: False - type: str + type: list + elements: str includes: description: - Include the associated collections or targeting rules details in the response. required: False type: list elements: str - segments: + limit: description: - - Filter features by a list of comma separated segments. + - The number of records to retrieve. By default, the list operation return the first 10 records. To retrieve different set of records, use `limit` with `offset` to page through the available records. required: False - type: list - elements: str + type: int + sort: + description: + - Sort the feature details based on the specified attribute. + required: False + type: str + tags: + description: + - Filter the resources to be returned based on the associated tags. Specify the parameter as a list of comma separated tags. Returns resources associated with any of the specified tags. + required: False + type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -113,16 +113,16 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'guid', 'collections', 'expand', - 'limit', 'offset', - 'tags', + 'guid', 'environment_id', - 'sort', - 'includes', 'segments', + 'includes', + 'limit', + 'sort', + 'tags', ] @@ -133,9 +133,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - guid=dict( - required=True, - type='str'), collections=dict( required=False, elements='', @@ -143,29 +140,32 @@ expand=dict( required=False, type='bool'), - limit=dict( - required=False, - type='int'), offset=dict( required=False, type='int'), - tags=dict( - required=False, + guid=dict( + required=True, type='str'), environment_id=dict( required=True, type='str'), - sort=dict( - required=False, - type='str'), - includes=dict( + segments=dict( required=False, elements='', type='list'), - segments=dict( + includes=dict( required=False, elements='', type='list'), + limit=dict( + required=False, + type='int'), + sort=dict( + required=False, + type='str'), + tags=dict( + required=False, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_app_route.py b/plugins/modules/ibm_app_route.py index dd8e49f36..ca6578c8a 100644 --- a/plugins/modules/ibm_app_route.py +++ b/plugins/modules/ibm_app_route.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - port: - description: - - The port of the route. Supported for domains of TCP router groups only. - required: False - type: int path: description: - The path for a route as raw text.Paths must be between 2 and 128 characters.Paths must start with a forward slash '/'.Paths must not contain a '?' @@ -53,6 +48,11 @@ - (Required for new resource) The guid of the associated domain required: True type: str + port: + description: + - The port of the route. Supported for domains of TCP router groups only. + required: False + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -105,12 +105,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'port', 'path', 'tags', 'host', 'space_guid', 'domain_guid', + 'port', ] # Params for Data source @@ -134,9 +134,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - port=dict( - required=False, - type='int'), path=dict( required=False, type='str'), @@ -153,6 +150,9 @@ domain_guid=dict( required=False, type='str'), + port=dict( + required=False, + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_appid_action_url.py b/plugins/modules/ibm_appid_action_url.py index b7458424d..505b898f6 100644 --- a/plugins/modules/ibm_appid_action_url.py +++ b/plugins/modules/ibm_appid_action_url.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + tenant_id: + description: + - (Required for new resource) The AppID instance GUID + required: True + type: str action: description: - (Required for new resource) The type of the action: `on_user_verified` - the URL of your custom user verified page, `on_reset_password` - the URL of your custom reset password page @@ -32,11 +37,6 @@ - (Required for new resource) The action URL required: True type: str - tenant_id: - description: - - (Required for new resource) The AppID instance GUID - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -83,16 +83,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('tenant_id', 'str'), ('action', 'str'), ('url', 'str'), - ('tenant_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'tenant_id', 'action', 'url', - 'tenant_id', ] # Params for Data source @@ -113,13 +113,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - action=dict( + tenant_id=dict( required=False, type='str'), - url=dict( + action=dict( required=False, type='str'), - tenant_id=dict( + url=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_appid_apm.py b/plugins/modules/ibm_appid_apm.py index a77b799cb..c2cdba5bf 100644 --- a/plugins/modules/ibm_appid_apm.py +++ b/plugins/modules/ibm_appid_apm.py @@ -22,6 +22,12 @@ - Terraform v0.12.20 options: + password_expiration: + description: + - (Required for new resource) + required: True + type: list + elements: dict lockout_policy: description: - (Required for new resource) @@ -56,12 +62,6 @@ required: True type: list elements: dict - password_expiration: - description: - - (Required for new resource) - required: True - type: list - elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -108,23 +108,23 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('password_expiration', 'list'), ('lockout_policy', 'list'), ('min_password_change_interval', 'list'), ('tenant_id', 'str'), ('enabled', 'bool'), ('password_reuse', 'list'), - ('password_expiration', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'password_expiration', 'lockout_policy', 'min_password_change_interval', 'tenant_id', 'enabled', 'prevent_password_with_username', 'password_reuse', - 'password_expiration', ] # Params for Data source @@ -143,6 +143,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + password_expiration=dict( + required=False, + elements='', + type='list'), lockout_policy=dict( required=False, elements='', @@ -164,10 +168,6 @@ required=False, elements='', type='list'), - password_expiration=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_appid_application.py b/plugins/modules/ibm_appid_application.py index d1ce9c939..62d8a71e9 100644 --- a/plugins/modules/ibm_appid_application.py +++ b/plugins/modules/ibm_appid_application.py @@ -97,13 +97,13 @@ # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('tenant_id', 'str'), ('client_id', 'str'), + ('tenant_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'tenant_id', 'client_id', + 'tenant_id', ] TL_CONFLICTS_MAP = { diff --git a/plugins/modules/ibm_appid_application_info.py b/plugins/modules/ibm_appid_application_info.py index 73467cfb3..4cd6386d3 100644 --- a/plugins/modules/ibm_appid_application_info.py +++ b/plugins/modules/ibm_appid_application_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - tenant_id: + client_id: description: - - The service `tenantId` + - The `client_id` is a public identifier for applications required: True type: str - client_id: + tenant_id: description: - - The `client_id` is a public identifier for applications + - The service `tenantId` required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('tenant_id', 'str'), ('client_id', 'str'), + ('tenant_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'tenant_id', 'client_id', + 'tenant_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - tenant_id=dict( + client_id=dict( required=True, type='str'), - client_id=dict( + tenant_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_appid_application_scopes.py b/plugins/modules/ibm_appid_application_scopes.py index e57583227..cffed0258 100644 --- a/plugins/modules/ibm_appid_application_scopes.py +++ b/plugins/modules/ibm_appid_application_scopes.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - tenant_id: - description: - - (Required for new resource) The service `tenantId` - required: True - type: str client_id: description: - (Required for new resource) The `client_id` is a public identifier for applications @@ -38,6 +33,11 @@ required: True type: list elements: str + tenant_id: + description: + - (Required for new resource) The service `tenantId` + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -84,16 +84,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('tenant_id', 'str'), ('client_id', 'str'), ('scopes', 'list'), + ('tenant_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'tenant_id', 'client_id', 'scopes', + 'tenant_id', ] # Params for Data source @@ -114,9 +114,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - tenant_id=dict( - required=False, - type='str'), client_id=dict( required=False, type='str'), @@ -124,6 +121,9 @@ required=False, elements='', type='list'), + tenant_id=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_appid_cloud_directory_template.py b/plugins/modules/ibm_appid_cloud_directory_template.py index 9e96b72b7..fb8d34011 100644 --- a/plugins/modules/ibm_appid_cloud_directory_template.py +++ b/plugins/modules/ibm_appid_cloud_directory_template.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - template_name: - description: - - (Required for new resource) The type of email template. This can be `USER_VERIFICATION`, `WELCOME`, `PASSWORD_CHANGED`, `RESET_PASSWORD` or `MFA_VERIFICATION` - required: True - type: str language: description: - Preferred language for resource. Format as described at RFC5646. According to the configured languages codes returned from the `GET /management/v4/{tenantId}/config/ui/languages API`. @@ -53,6 +48,11 @@ - (Required for new resource) The AppID instance GUID required: True type: str + template_name: + description: + - (Required for new resource) The type of email template. This can be `USER_VERIFICATION`, `WELCOME`, `PASSWORD_CHANGED`, `RESET_PASSWORD` or `MFA_VERIFICATION` + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -99,19 +99,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('template_name', 'str'), ('subject', 'str'), ('tenant_id', 'str'), + ('template_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'template_name', 'language', 'subject', 'html_body', 'plain_text_body', 'tenant_id', + 'template_name', ] # Params for Data source @@ -133,9 +133,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - template_name=dict( - required=False, - type='str'), language=dict( required=False, type='str'), @@ -151,6 +148,9 @@ tenant_id=dict( required=False, type='str'), + template_name=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_appid_cloud_directory_user.py b/plugins/modules/ibm_appid_cloud_directory_user.py index 786eaeebb..f9fafd18f 100644 --- a/plugins/modules/ibm_appid_cloud_directory_user.py +++ b/plugins/modules/ibm_appid_cloud_directory_user.py @@ -22,55 +22,55 @@ - Terraform v0.12.20 options: - active: + display_name: description: - - Determines if the user account is active or not + - Cloud Directory user display name required: False - type: bool - default: True - locked_until: + type: str + user_name: description: - - Integer (epoch time in milliseconds), determines till when the user account will be locked + - Optional username required: False - type: int + type: str + password: + description: + - (Required for new resource) User password + required: True + type: str status: description: - Accepted values `PENDING` or `CONFIRMED` required: False type: str default: PENDING + create_profile: + description: + - A boolean indication if a profile should be created for the Cloud Directory user + required: False + type: bool + default: True + locked_until: + description: + - Integer (epoch time in milliseconds), determines till when the user account will be locked + required: False + type: int email: description: - (Required for new resource) A set of user emails required: True type: list elements: dict - password: - description: - - (Required for new resource) User password - required: True - type: str tenant_id: description: - (Required for new resource) The AppID instance GUID required: True type: str - create_profile: + active: description: - - A boolean indication if a profile should be created for the Cloud Directory user + - Determines if the user account is active or not required: False type: bool default: True - display_name: - description: - - Cloud Directory user display name - required: False - type: str - user_name: - description: - - Optional username - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -117,33 +117,33 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('email', 'list'), ('password', 'str'), + ('email', 'list'), ('tenant_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'active', - 'locked_until', + 'display_name', + 'user_name', + 'password', 'status', + 'create_profile', + 'locked_until', 'email', - 'password', 'tenant_id', - 'create_profile', - 'display_name', - 'user_name', + 'active', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('user_id', 'str'), ('tenant_id', 'str'), + ('user_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'user_id', 'tenant_id', + 'user_id', ] TL_CONFLICTS_MAP = { @@ -153,34 +153,34 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - active=dict( - required=False, - type='bool'), - locked_until=dict( - required=False, - type='int'), - status=dict( + display_name=dict( required=False, type='str'), - email=dict( + user_name=dict( required=False, - elements='', - type='list'), + type='str'), password=dict( required=False, type='str'), - tenant_id=dict( + status=dict( required=False, type='str'), create_profile=dict( required=False, type='bool'), - display_name=dict( + locked_until=dict( required=False, - type='str'), - user_name=dict( + type='int'), + email=dict( + required=False, + elements='', + type='list'), + tenant_id=dict( required=False, type='str'), + active=dict( + required=False, + type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_appid_cloud_directory_user_info.py b/plugins/modules/ibm_appid_cloud_directory_user_info.py index bb8131642..2759c239b 100644 --- a/plugins/modules/ibm_appid_cloud_directory_user_info.py +++ b/plugins/modules/ibm_appid_cloud_directory_user_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - user_id: + tenant_id: description: - - Cloud Directory user ID + - The AppID instance GUID required: True type: str - tenant_id: + user_id: description: - - The AppID instance GUID + - Cloud Directory user ID required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('user_id', 'str'), ('tenant_id', 'str'), + ('user_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'user_id', 'tenant_id', + 'user_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - user_id=dict( + tenant_id=dict( required=True, type='str'), - tenant_id=dict( + user_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_appid_idp_cloud_directory.py b/plugins/modules/ibm_appid_idp_cloud_directory.py index ae7f5b434..b37c2c819 100644 --- a/plugins/modules/ibm_appid_idp_cloud_directory.py +++ b/plugins/modules/ibm_appid_idp_cloud_directory.py @@ -22,19 +22,25 @@ - Terraform v0.12.20 options: - signup_enabled: + welcome_enabled: description: - None required: False type: bool default: True - welcome_enabled: + reset_password_enabled: description: - None required: False type: bool default: True - reset_password_enabled: + identity_confirm_methods: + description: + - None + required: False + type: list + elements: str + signup_enabled: description: - None required: False @@ -52,12 +58,11 @@ required: False type: str default: FULL - identity_confirm_methods: + identity_field: description: - None required: False - type: list - elements: str + type: str tenant_id: description: - (Required for new resource) @@ -74,11 +79,6 @@ required: False type: bool default: True - identity_field: - description: - - None - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -131,16 +131,16 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'signup_enabled', 'welcome_enabled', 'reset_password_enabled', + 'identity_confirm_methods', + 'signup_enabled', 'reset_password_notification_enabled', 'identity_confirm_access_mode', - 'identity_confirm_methods', + 'identity_field', 'tenant_id', 'is_active', 'self_service_enabled', - 'identity_field', ] # Params for Data source @@ -159,25 +159,28 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - signup_enabled=dict( - required=False, - type='bool'), welcome_enabled=dict( required=False, type='bool'), reset_password_enabled=dict( required=False, type='bool'), + identity_confirm_methods=dict( + required=False, + elements='', + type='list'), + signup_enabled=dict( + required=False, + type='bool'), reset_password_notification_enabled=dict( required=False, type='bool'), identity_confirm_access_mode=dict( required=False, type='str'), - identity_confirm_methods=dict( + identity_field=dict( required=False, - elements='', - type='list'), + type='str'), tenant_id=dict( required=False, type='str'), @@ -187,9 +190,6 @@ self_service_enabled=dict( required=False, type='bool'), - identity_field=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_appid_idp_custom.py b/plugins/modules/ibm_appid_idp_custom.py index 6494bc992..fe4b965d3 100644 --- a/plugins/modules/ibm_appid_idp_custom.py +++ b/plugins/modules/ibm_appid_idp_custom.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + public_key: + description: + - This is the public key used to validate your signed JWT. It is required to be a PEM in the RS256 or greater format. + required: False + type: str tenant_id: description: - (Required for new resource) The service `tenantId` @@ -32,11 +37,6 @@ - (Required for new resource) required: True type: bool - public_key: - description: - - This is the public key used to validate your signed JWT. It is required to be a PEM in the RS256 or greater format. - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -89,9 +89,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'public_key', 'tenant_id', 'is_active', - 'public_key', ] # Params for Data source @@ -110,15 +110,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + public_key=dict( + required=False, + type='str'), tenant_id=dict( required=False, type='str'), is_active=dict( required=False, type='bool'), - public_key=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_appid_idp_google.py b/plugins/modules/ibm_appid_idp_google.py index 68fa06310..42dbb5d44 100644 --- a/plugins/modules/ibm_appid_idp_google.py +++ b/plugins/modules/ibm_appid_idp_google.py @@ -22,12 +22,6 @@ - Terraform v0.12.20 options: - config: - description: - - Google IDP configuration - required: False - type: list - elements: dict tenant_id: description: - (Required for new resource) The AppID instance GUID @@ -38,6 +32,12 @@ - (Required for new resource) `true` if Google IDP configuration is active required: True type: bool + config: + description: + - Google IDP configuration + required: False + type: list + elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -90,9 +90,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'config', 'tenant_id', 'is_active', + 'config', ] # Params for Data source @@ -111,16 +111,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - config=dict( - required=False, - elements='', - type='list'), tenant_id=dict( required=False, type='str'), is_active=dict( required=False, type='bool'), + config=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_appid_token_config.py b/plugins/modules/ibm_appid_token_config.py index 2184d5a07..7663c289e 100644 --- a/plugins/modules/ibm_appid_token_config.py +++ b/plugins/modules/ibm_appid_token_config.py @@ -22,6 +22,22 @@ - Terraform v0.12.20 options: + anonymous_token_expires_in: + description: + - None + required: False + type: int + default: 2592000 + anonymous_access_enabled: + description: + - The length of time for which an anonymous token is valid in seconds + required: False + type: bool + refresh_token_enabled: + description: + - None + required: False + type: bool access_token_claim: description: - A set of objects that are created when claims that are related to access tokens are mapped @@ -50,22 +66,6 @@ required: False type: int default: 2592000 - anonymous_token_expires_in: - description: - - None - required: False - type: int - default: 2592000 - anonymous_access_enabled: - description: - - The length of time for which an anonymous token is valid in seconds - required: False - type: bool - refresh_token_enabled: - description: - - None - required: False - type: bool id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -117,14 +117,14 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'anonymous_token_expires_in', + 'anonymous_access_enabled', + 'refresh_token_enabled', 'access_token_claim', 'id_token_claim', 'tenant_id', 'access_token_expires_in', 'refresh_token_expires_in', - 'anonymous_token_expires_in', - 'anonymous_access_enabled', - 'refresh_token_enabled', ] # Params for Data source @@ -143,6 +143,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + anonymous_token_expires_in=dict( + required=False, + type='int'), + anonymous_access_enabled=dict( + required=False, + type='bool'), + refresh_token_enabled=dict( + required=False, + type='bool'), access_token_claim=dict( required=False, elements='', @@ -160,15 +169,6 @@ refresh_token_expires_in=dict( required=False, type='int'), - anonymous_token_expires_in=dict( - required=False, - type='int'), - anonymous_access_enabled=dict( - required=False, - type='bool'), - refresh_token_enabled=dict( - required=False, - type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_appid_user_roles.py b/plugins/modules/ibm_appid_user_roles.py index 30364e325..f2b90bcea 100644 --- a/plugins/modules/ibm_appid_user_roles.py +++ b/plugins/modules/ibm_appid_user_roles.py @@ -22,6 +22,12 @@ - Terraform v0.12.20 options: + role_ids: + description: + - (Required for new resource) A set of AppID role IDs that should be assigned to the user + required: True + type: list + elements: str tenant_id: description: - (Required for new resource) The AppID instance GUID @@ -32,12 +38,6 @@ - (Required for new resource) The user's identifier ('subject' in identity token) required: True type: str - role_ids: - description: - - (Required for new resource) A set of AppID role IDs that should be assigned to the user - required: True - type: list - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -84,16 +84,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('role_ids', 'list'), ('tenant_id', 'str'), ('subject', 'str'), - ('role_ids', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'role_ids', 'tenant_id', 'subject', - 'role_ids', ] # Params for Data source @@ -114,16 +114,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + role_ids=dict( + required=False, + elements='', + type='list'), tenant_id=dict( required=False, type='str'), subject=dict( required=False, type='str'), - role_ids=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cbr_rule.py b/plugins/modules/ibm_cbr_rule.py index 4c8938fd7..63b8d6e42 100644 --- a/plugins/modules/ibm_cbr_rule.py +++ b/plugins/modules/ibm_cbr_rule.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - description: - description: - - The description of the rule. - required: False - type: str contexts: description: - (Required for new resource) The contexts this rule applies to. @@ -39,6 +34,11 @@ required: True type: list elements: dict + description: + description: + - The description of the rule. + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -91,9 +91,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'description', 'contexts', 'resources', + 'description', ] # Params for Data source @@ -112,9 +112,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - description=dict( - required=False, - type='str'), contexts=dict( required=False, elements='', @@ -123,6 +120,9 @@ required=False, elements='', type='list'), + description=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cbr_zone.py b/plugins/modules/ibm_cbr_zone.py index 2dc78701a..bf5477577 100644 --- a/plugins/modules/ibm_cbr_zone.py +++ b/plugins/modules/ibm_cbr_zone.py @@ -33,17 +33,17 @@ required: True type: list elements: dict + name: + description: + - (Required for new resource) The name of the zone. + required: True + type: str excluded: description: - The list of excluded addresses in the zone. Only addresses of type `ipAddress`, `ipRange`, and `subnet` can be excluded. required: False type: list elements: dict - name: - description: - - (Required for new resource) The name of the zone. - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -98,8 +98,8 @@ TL_ALL_PARAMETERS = [ 'description', 'addresses', - 'excluded', 'name', + 'excluded', ] # Params for Data source @@ -125,13 +125,13 @@ required=False, elements='', type='list'), + name=dict( + required=False, + type='str'), excluded=dict( required=False, elements='', type='list'), - name=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cdn.py b/plugins/modules/ibm_cdn.py index 8f0eddd5a..25931f408 100644 --- a/plugins/modules/ibm_cdn.py +++ b/plugins/modules/ibm_cdn.py @@ -22,33 +22,18 @@ - Terraform v0.12.20 options: - bucket_name: + origin_type: description: - - Bucket name + - Origin type info required: False type: str - http_port: + default: HOST_SERVER + https_port: description: - - HTTP port number + - HTTPS port number required: False type: int - default: 80 - respect_headers: - description: - - respect headers info - required: False - type: bool - default: True - host_name: - description: - - (Required for new resource) Host name - required: True - type: str - cname: - description: - - cname info - required: False - type: str + default: 443 file_extension: description: - File extension info @@ -60,12 +45,24 @@ required: False type: str default: include-all + performance_configuration: + description: + - performance configuration info + required: False + type: str + default: General web delivery path: description: - Path details required: False type: str default: /* + vendor_name: + description: + - Vendor name + required: False + type: str + default: akamai origin_address: description: - (Required for new resource) origin address info @@ -77,40 +74,43 @@ required: False type: str default: HTTP - performance_configuration: + cname: description: - - performance configuration info + - cname info required: False type: str - default: General web delivery - vendor_name: + host_name: description: - - Vendor name - required: False + - (Required for new resource) Host name + required: True type: str - default: akamai - origin_type: + bucket_name: description: - - Origin type info + - Bucket name required: False type: str - default: HOST_SERVER - https_port: + http_port: description: - - HTTPS port number + - HTTP port number required: False type: int - default: 443 - header: + default: 80 + respect_headers: description: - - Header info + - respect headers info required: False - type: str + type: bool + default: True certificate_type: description: - Certificate type required: False type: str + header: + description: + - Header info + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -157,28 +157,28 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('host_name', 'str'), ('origin_address', 'str'), + ('host_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'bucket_name', - 'http_port', - 'respect_headers', - 'host_name', - 'cname', + 'origin_type', + 'https_port', 'file_extension', 'cache_key_query_rule', + 'performance_configuration', 'path', + 'vendor_name', 'origin_address', 'protocol', - 'performance_configuration', - 'vendor_name', - 'origin_type', - 'https_port', - 'header', + 'cname', + 'host_name', + 'bucket_name', + 'http_port', + 'respect_headers', 'certificate_type', + 'header', ] # Params for Data source @@ -195,28 +195,25 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - bucket_name=dict( + origin_type=dict( required=False, type='str'), - http_port=dict( + https_port=dict( required=False, type='int'), - respect_headers=dict( - required=False, - type='bool'), - host_name=dict( + file_extension=dict( required=False, type='str'), - cname=dict( + cache_key_query_rule=dict( required=False, type='str'), - file_extension=dict( + performance_configuration=dict( required=False, type='str'), - cache_key_query_rule=dict( + path=dict( required=False, type='str'), - path=dict( + vendor_name=dict( required=False, type='str'), origin_address=dict( @@ -225,24 +222,27 @@ protocol=dict( required=False, type='str'), - performance_configuration=dict( + cname=dict( required=False, type='str'), - vendor_name=dict( + host_name=dict( required=False, type='str'), - origin_type=dict( + bucket_name=dict( required=False, type='str'), - https_port=dict( + http_port=dict( required=False, type='int'), - header=dict( + respect_headers=dict( required=False, - type='str'), + type='bool'), certificate_type=dict( required=False, type='str'), + header=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_certificate_manager_certificate_info.py b/plugins/modules/ibm_certificate_manager_certificate_info.py index 29aa70daf..ebc4b6034 100644 --- a/plugins/modules/ibm_certificate_manager_certificate_info.py +++ b/plugins/modules/ibm_certificate_manager_certificate_info.py @@ -21,12 +21,12 @@ - Terraform v0.12.20 options: - name: + certificate_manager_instance_id: description: - None required: True type: str - certificate_manager_instance_id: + name: description: - None required: True @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('certificate_manager_instance_id', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'certificate_manager_instance_id', + 'name', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + certificate_manager_instance_id=dict( required=True, type='str'), - certificate_manager_instance_id=dict( + name=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_certificate_manager_import.py b/plugins/modules/ibm_certificate_manager_import.py index a43a5f0f4..c45f6eedc 100644 --- a/plugins/modules/ibm_certificate_manager_import.py +++ b/plugins/modules/ibm_certificate_manager_import.py @@ -27,16 +27,16 @@ - (Required for new resource) Instance ID of the certificate manager resource required: True type: str - data: - description: - - (Required for new resource) certificate data - required: True - type: dict name: description: - (Required for new resource) Name of the instance required: True type: str + data: + description: + - (Required for new resource) certificate data + required: True + type: dict description: description: - Description of the certificate instance @@ -89,15 +89,15 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('certificate_manager_instance_id', 'str'), - ('data', 'dict'), ('name', 'str'), + ('data', 'dict'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'certificate_manager_instance_id', - 'data', 'name', + 'data', 'description', ] @@ -118,12 +118,12 @@ certificate_manager_instance_id=dict( required=False, type='str'), - data=dict( - required=False, - type='dict'), name=dict( required=False, type='str'), + data=dict( + required=False, + type='dict'), description=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_certificate_manager_order.py b/plugins/modules/ibm_certificate_manager_order.py index 9da2c45bc..d0b84c7e5 100644 --- a/plugins/modules/ibm_certificate_manager_order.py +++ b/plugins/modules/ibm_certificate_manager_order.py @@ -22,62 +22,62 @@ - Terraform v0.12.20 options: - key_algorithm: - description: - - Keyalgorithm info - required: False - type: str - default: rsaEncryption 2048 bit auto_renew_enabled: description: - None required: False type: bool default: False - name: - description: - - (Required for new resource) Certificate name - required: True - type: str domains: description: - (Required for new resource) List of domain names required: True type: list elements: str - dns_provider_instance_crn: + domain_validation_method: description: - - DNS provider instance CRN + - Domain validation methods required: False type: str + default: dns-01 certificate_manager_instance_id: description: - (Required for new resource) Certificate manager instance ID required: True type: str - description: - description: - - Certicate description - required: False - type: str renew_certificate: description: - Invokes renew functionality required: False type: bool default: False - domain_validation_method: + key_algorithm: description: - - Domain validation methods + - Keyalgorithm info required: False type: str - default: dns-01 + default: rsaEncryption 2048 bit + name: + description: + - (Required for new resource) Certificate name + required: True + type: str rotate_keys: description: - Keys are sorated if set to true required: False type: bool default: False + description: + description: + - Certicate description + required: False + type: str + dns_provider_instance_crn: + description: + - DNS provider instance CRN + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -124,23 +124,23 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('domains', 'list'), ('certificate_manager_instance_id', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'key_algorithm', 'auto_renew_enabled', - 'name', 'domains', - 'dns_provider_instance_crn', + 'domain_validation_method', 'certificate_manager_instance_id', - 'description', 'renew_certificate', - 'domain_validation_method', + 'key_algorithm', + 'name', 'rotate_keys', + 'description', + 'dns_provider_instance_crn', ] # Params for Data source @@ -157,37 +157,37 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - key_algorithm=dict( - required=False, - type='str'), auto_renew_enabled=dict( required=False, type='bool'), - name=dict( - required=False, - type='str'), domains=dict( required=False, elements='', type='list'), - dns_provider_instance_crn=dict( + domain_validation_method=dict( required=False, type='str'), certificate_manager_instance_id=dict( required=False, type='str'), - description=dict( - required=False, - type='str'), renew_certificate=dict( required=False, type='bool'), - domain_validation_method=dict( + key_algorithm=dict( + required=False, + type='str'), + name=dict( required=False, type='str'), rotate_keys=dict( required=False, type='bool'), + description=dict( + required=False, + type='str'), + dns_provider_instance_crn=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cis.py b/plugins/modules/ibm_cis.py index 5939cfd61..08b4d41bc 100644 --- a/plugins/modules/ibm_cis.py +++ b/plugins/modules/ibm_cis.py @@ -22,19 +22,20 @@ - Terraform v0.12.20 options: - parameters: + tags: description: - - Arbitrary parameters to pass. Must be a JSON object + - None required: False - type: dict - name: + type: list + elements: str + plan: description: - - (Required for new resource) A name for the resource instance + - (Required for new resource) The plan type of the service required: True type: str - plan: + name: description: - - (Required for new resource) The plan type of the service + - (Required for new resource) A name for the resource instance required: True type: str location: @@ -42,17 +43,16 @@ - (Required for new resource) The location where the instance available required: True type: str + parameters: + description: + - Arbitrary parameters to pass. Must be a JSON object + required: False + type: dict resource_group_id: description: - The resource group id required: False type: str - tags: - description: - - None - required: False - type: list - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -99,19 +99,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('plan', 'str'), + ('name', 'str'), ('location', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'parameters', - 'name', + 'tags', 'plan', + 'name', 'location', + 'parameters', 'resource_group_id', - 'tags', ] # Params for Data source @@ -131,25 +131,25 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - parameters=dict( + tags=dict( required=False, - type='dict'), - name=dict( + elements='', + type='list'), + plan=dict( required=False, type='str'), - plan=dict( + name=dict( required=False, type='str'), location=dict( required=False, type='str'), + parameters=dict( + required=False, + type='dict'), resource_group_id=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cis_cache_settings.py b/plugins/modules/ibm_cis_cache_settings.py index 58a9a337f..56aeaefab 100644 --- a/plugins/modules/ibm_cis_cache_settings.py +++ b/plugins/modules/ibm_cis_cache_settings.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + cis_id: + description: + - (Required for new resource) CIS instance crn + required: True + type: str domain_id: description: - (Required for new resource) Associated CIS domain @@ -32,17 +37,23 @@ - Cache level setting required: False type: str + browser_expiration: + description: + - Browser Expiration setting + required: False + type: int + purge_by_urls: + description: + - Purge by URLs + required: False + type: list + elements: str serve_stale_content: description: - Serve Stale Content required: False type: str default: on - browser_expiration: - description: - - Browser Expiration setting - required: False - type: int development_mode: description: - Development mode setting @@ -53,31 +64,20 @@ - Query String sort setting required: False type: str - purge_by_hosts: - description: - - Purge by hosts - required: False - type: list - elements: str - cis_id: - description: - - (Required for new resource) CIS instance crn - required: True - type: str purge_all: description: - Purge all setting required: False type: bool - purge_by_urls: + purge_by_tags: description: - - Purge by URLs + - Purge by tags required: False type: list elements: str - purge_by_tags: + purge_by_hosts: description: - - Purge by tags + - Purge by hosts required: False type: list elements: str @@ -127,80 +127,80 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('domain_id', 'str'), ('cis_id', 'str'), + ('domain_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'cis_id', 'domain_id', 'caching_level', - 'serve_stale_content', 'browser_expiration', + 'purge_by_urls', + 'serve_stale_content', 'development_mode', 'query_string_sort', - 'purge_by_hosts', - 'cis_id', 'purge_all', - 'purge_by_urls', 'purge_by_tags', + 'purge_by_hosts', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('cis_id', 'str'), ('domain_id', 'str'), + ('cis_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'cis_id', 'domain_id', + 'cis_id', ] TL_CONFLICTS_MAP = { - 'purge_by_hosts': ['purge_all', 'purge_by_urls', 'purge_by_tags'], - 'purge_all': ['purge_by_urls', 'purge_by_tags', 'purge_by_hosts'], 'purge_by_urls': ['purge_all', 'purge_by_tags', 'purge_by_hosts'], + 'purge_all': ['purge_by_urls', 'purge_by_tags', 'purge_by_hosts'], 'purge_by_tags': ['purge_all', 'purge_by_urls', 'purge_by_hosts'], + 'purge_by_hosts': ['purge_all', 'purge_by_urls', 'purge_by_tags'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - domain_id=dict( + cis_id=dict( required=False, type='str'), - caching_level=dict( + domain_id=dict( required=False, type='str'), - serve_stale_content=dict( + caching_level=dict( required=False, type='str'), browser_expiration=dict( required=False, type='int'), - development_mode=dict( + purge_by_urls=dict( required=False, - type='str'), - query_string_sort=dict( + elements='', + type='list'), + serve_stale_content=dict( required=False, type='str'), - purge_by_hosts=dict( + development_mode=dict( required=False, - elements='', - type='list'), - cis_id=dict( + type='str'), + query_string_sort=dict( required=False, type='str'), purge_all=dict( required=False, type='bool'), - purge_by_urls=dict( + purge_by_tags=dict( required=False, elements='', type='list'), - purge_by_tags=dict( + purge_by_hosts=dict( required=False, elements='', type='list'), diff --git a/plugins/modules/ibm_cis_cache_settings_info.py b/plugins/modules/ibm_cis_cache_settings_info.py index 431a0e2c8..88b53ffa7 100644 --- a/plugins/modules/ibm_cis_cache_settings_info.py +++ b/plugins/modules/ibm_cis_cache_settings_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - cis_id: + domain_id: description: - - CIS instance crn + - Associated CIS domain required: True type: str - domain_id: + cis_id: description: - - Associated CIS domain + - CIS instance crn required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('cis_id', 'str'), ('domain_id', 'str'), + ('cis_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'cis_id', 'domain_id', + 'cis_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - cis_id=dict( + domain_id=dict( required=True, type='str'), - domain_id=dict( + cis_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_cis_certificate_order.py b/plugins/modules/ibm_cis_certificate_order.py index 01a99f244..1f2103274 100644 --- a/plugins/modules/ibm_cis_certificate_order.py +++ b/plugins/modules/ibm_cis_certificate_order.py @@ -22,12 +22,6 @@ - Terraform v0.12.20 options: - hosts: - description: - - (Required for new resource) Hosts which certificate need to be ordered - required: True - type: list - elements: str cis_id: description: - (Required for new resource) CIS object id or CRN @@ -44,6 +38,12 @@ required: False type: str default: dedicated + hosts: + description: + - (Required for new resource) Hosts which certificate need to be ordered + required: True + type: list + elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -90,17 +90,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('hosts', 'list'), ('cis_id', 'str'), ('domain_id', 'str'), + ('hosts', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'hosts', 'cis_id', 'domain_id', 'type', + 'hosts', ] # Params for Data source @@ -117,10 +117,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - hosts=dict( - required=False, - elements='', - type='list'), cis_id=dict( required=False, type='str'), @@ -130,6 +126,10 @@ type=dict( required=False, type='str'), + hosts=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cis_certificate_upload.py b/plugins/modules/ibm_cis_certificate_upload.py index ffd853f68..54e965abc 100644 --- a/plugins/modules/ibm_cis_certificate_upload.py +++ b/plugins/modules/ibm_cis_certificate_upload.py @@ -22,35 +22,35 @@ - Terraform v0.12.20 options: - bundle_method: + certificate: description: - - Certificate bundle method - required: False + - (Required for new resource) Certificate key + required: True type: str - default: ubiquitous private_key: description: - (Required for new resource) Certificate private key required: True type: str + bundle_method: + description: + - Certificate bundle method + required: False + type: str + default: ubiquitous priority: description: - Certificate priority required: False type: int - cis_id: - description: - - (Required for new resource) CIS instance crn - required: True - type: str domain_id: description: - (Required for new resource) Associated CIS domain required: True type: str - certificate: + cis_id: description: - - (Required for new resource) Certificate key + - (Required for new resource) CIS instance crn required: True type: str id: @@ -99,20 +99,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('certificate', 'str'), ('private_key', 'str'), - ('cis_id', 'str'), ('domain_id', 'str'), - ('certificate', 'str'), + ('cis_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'bundle_method', + 'certificate', 'private_key', + 'bundle_method', 'priority', - 'cis_id', 'domain_id', - 'certificate', + 'cis_id', ] # Params for Data source @@ -129,22 +129,22 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - bundle_method=dict( + certificate=dict( required=False, type='str'), private_key=dict( required=False, type='str'), + bundle_method=dict( + required=False, + type='str'), priority=dict( required=False, type='int'), - cis_id=dict( - required=False, - type='str'), domain_id=dict( required=False, type='str'), - certificate=dict( + cis_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cis_custom_page.py b/plugins/modules/ibm_cis_custom_page.py index 9b7ee6138..6a9916ff4 100644 --- a/plugins/modules/ibm_cis_custom_page.py +++ b/plugins/modules/ibm_cis_custom_page.py @@ -22,24 +22,24 @@ - Terraform v0.12.20 options: - page_id: + cis_id: description: - - (Required for new resource) Custom page identifier + - (Required for new resource) CIS instance crn required: True type: str - url: + domain_id: description: - - (Required for new resource) Custom page url + - (Required for new resource) Associated CIS domain required: True type: str - cis_id: + page_id: description: - - (Required for new resource) CIS instance crn + - (Required for new resource) Custom page identifier required: True type: str - domain_id: + url: description: - - (Required for new resource) Associated CIS domain + - (Required for new resource) Custom page url required: True type: str id: @@ -88,18 +88,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('page_id', 'str'), - ('url', 'str'), ('cis_id', 'str'), ('domain_id', 'str'), + ('page_id', 'str'), + ('url', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'page_id', - 'url', 'cis_id', 'domain_id', + 'page_id', + 'url', ] # Params for Data source @@ -116,16 +116,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - page_id=dict( + cis_id=dict( required=False, type='str'), - url=dict( + domain_id=dict( required=False, type='str'), - cis_id=dict( + page_id=dict( required=False, type='str'), - domain_id=dict( + url=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cis_dns_record.py b/plugins/modules/ibm_cis_dns_record.py index 06c7636f3..fb90f3da2 100644 --- a/plugins/modules/ibm_cis_dns_record.py +++ b/plugins/modules/ibm_cis_dns_record.py @@ -27,27 +27,27 @@ - (Required for new resource) CIS object id or CRN required: True type: str - data: - description: - - None - required: False - type: dict priority: description: - Priority Value required: False type: int + proxied: + description: + - Boolean value true if proxied else flase + required: False + type: bool + default: False name: description: - DNS record name required: False type: str - ttl: + content: description: - - TTL value + - DNS record content required: False - type: int - default: 1 + type: str domain_id: description: - (Required for new resource) Associated CIS domain @@ -58,17 +58,17 @@ - (Required for new resource) Record type required: True type: str - content: + data: description: - - DNS record content + - None required: False - type: str - proxied: + type: dict + ttl: description: - - Boolean value true if proxied else flase + - TTL value required: False - type: bool - default: False + type: int + default: 1 id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -123,14 +123,14 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'cis_id', - 'data', 'priority', + 'proxied', 'name', - 'ttl', + 'content', 'domain_id', 'type', - 'content', - 'proxied', + 'data', + 'ttl', ] # Params for Data source @@ -141,8 +141,8 @@ ] TL_CONFLICTS_MAP = { - 'data': ['content'], 'content': ['data'], + 'data': ['content'], } # define available arguments/parameters a user can pass to the module @@ -152,30 +152,30 @@ cis_id=dict( required=False, type='str'), - data=dict( - required=False, - type='dict'), priority=dict( required=False, type='int'), + proxied=dict( + required=False, + type='bool'), name=dict( required=False, type='str'), - ttl=dict( + content=dict( required=False, - type='int'), + type='str'), domain_id=dict( required=False, type='str'), type=dict( required=False, type='str'), - content=dict( + data=dict( required=False, - type='str'), - proxied=dict( + type='dict'), + ttl=dict( required=False, - type='bool'), + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cis_dns_records_import.py b/plugins/modules/ibm_cis_dns_records_import.py index 2737b45e9..2efb82c1d 100644 --- a/plugins/modules/ibm_cis_dns_records_import.py +++ b/plugins/modules/ibm_cis_dns_records_import.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + file: + description: + - (Required for new resource) File to import + required: True + type: str cis_id: description: - (Required for new resource) CIS instance crn @@ -32,11 +37,6 @@ - (Required for new resource) Associated CIS domain required: True type: str - file: - description: - - (Required for new resource) File to import - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -83,16 +83,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('file', 'str'), ('cis_id', 'str'), ('domain_id', 'str'), - ('file', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'file', 'cis_id', 'domain_id', - 'file', ] # Params for Data source @@ -109,13 +109,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - cis_id=dict( + file=dict( required=False, type='str'), - domain_id=dict( + cis_id=dict( required=False, type='str'), - file=dict( + domain_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cis_domain_settings.py b/plugins/modules/ibm_cis_domain_settings.py index d6ed8e85c..56cabae24 100644 --- a/plugins/modules/ibm_cis_domain_settings.py +++ b/plugins/modules/ibm_cis_domain_settings.py @@ -22,85 +22,93 @@ - Terraform v0.12.20 options: - server_side_exclude: + max_upload: description: - - server_side_exclude setting + - Maximum upload required: False - type: str - true_client_ip_header: + type: int + minify: description: - - true_client_ip_header setting + - Minify setting required: False - type: str - dnssec: + type: list + elements: dict + ip_geolocation: description: - - DNS Sec setting + - ip_geolocation setting required: False type: str - waf: + image_size_optimization: description: - - WAF setting + - image_size_optimization setting required: False type: str - ipv6: + origin_error_page_pass_thru: description: - - ipv6 setting + - origin_error_page_pass_thru setting required: False type: str - image_load_optimization: + response_buffering: description: - - image_load_optimization setting + - response_buffering setting required: False type: str - max_upload: + server_side_exclude: description: - - Maximum upload + - server_side_exclude setting required: False - type: int - mobile_redirect: + type: str + websockets: description: - - None + - websockets setting required: False - type: list - elements: dict - opportunistic_encryption: + type: str + cname_flattening: description: - - opportunistic_encryption setting + - cname_flattening setting required: False type: str - brotli: + prefetch_preload: description: - - brotli setting + - prefetch_preload setting required: False type: str - websockets: + cipher: description: - - websockets setting + - Cipher settings required: False - type: str - tls_client_auth: + type: list + elements: str + mobile_redirect: description: - - tls_client_auth setting + - None required: False - type: str - cis_id: + type: list + elements: dict + domain_id: description: - - (Required for new resource) CIS instance crn + - (Required for new resource) Associated CIS domain required: True type: str - ssl: + browser_check: description: - - SSL/TLS setting + - browser_check setting required: False type: str - browser_check: + tls_client_auth: description: - - browser_check setting + - tls_client_auth setting required: False type: str - http2: + security_header: description: - - http2 setting + - Security Header Setting + required: False + type: list + elements: dict + dnssec: + description: + - DNS Sec setting required: False type: str min_tls_version: @@ -109,87 +117,79 @@ required: False type: str default: 1.1 - always_use_https: + automatic_https_rewrites: description: - - always_use_https setting + - automatic_https_rewrites setting required: False type: str - script_load_optimization: + always_use_https: description: - - script_load_optimization setting + - always_use_https setting required: False type: str - prefetch_preload: + ipv6: description: - - prefetch_preload setting + - ipv6 setting required: False type: str - response_buffering: + http2: description: - - response_buffering setting + - http2 setting required: False type: str - challenge_ttl: + brotli: description: - - Challenge TTL setting + - brotli setting required: False - type: int - cipher: + type: str + pseudo_ipv4: description: - - Cipher settings + - pseudo_ipv4 setting required: False - type: list - elements: str - cname_flattening: + type: str + waf: description: - - cname_flattening setting + - WAF setting required: False type: str - hotlink_protection: + ssl: description: - - hotlink_protection setting + - SSL/TLS setting required: False type: str - ip_geolocation: + true_client_ip_header: description: - - ip_geolocation setting + - true_client_ip_header setting required: False type: str - origin_error_page_pass_thru: + cis_id: description: - - origin_error_page_pass_thru setting - required: False + - (Required for new resource) CIS instance crn + required: True type: str - security_header: + hotlink_protection: description: - - Security Header Setting + - hotlink_protection setting required: False - type: list - elements: dict - minify: + type: str + image_load_optimization: description: - - Minify setting + - image_load_optimization setting required: False - type: list - elements: dict - domain_id: - description: - - (Required for new resource) Associated CIS domain - required: True type: str - automatic_https_rewrites: + script_load_optimization: description: - - automatic_https_rewrites setting + - script_load_optimization setting required: False type: str - image_size_optimization: + challenge_ttl: description: - - image_size_optimization setting + - Challenge TTL setting required: False - type: str - pseudo_ipv4: + type: int + opportunistic_encryption: description: - - pseudo_ipv4 setting + - opportunistic_encryption setting required: False type: str id: @@ -238,45 +238,45 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('cis_id', 'str'), ('domain_id', 'str'), + ('cis_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'server_side_exclude', - 'true_client_ip_header', - 'dnssec', - 'waf', - 'ipv6', - 'image_load_optimization', 'max_upload', - 'mobile_redirect', - 'opportunistic_encryption', - 'brotli', + 'minify', + 'ip_geolocation', + 'image_size_optimization', + 'origin_error_page_pass_thru', + 'response_buffering', + 'server_side_exclude', 'websockets', - 'tls_client_auth', - 'cis_id', - 'ssl', - 'browser_check', - 'http2', - 'min_tls_version', - 'always_use_https', - 'script_load_optimization', + 'cname_flattening', 'prefetch_preload', - 'response_buffering', - 'challenge_ttl', 'cipher', - 'cname_flattening', - 'hotlink_protection', - 'ip_geolocation', - 'origin_error_page_pass_thru', - 'security_header', - 'minify', + 'mobile_redirect', 'domain_id', + 'browser_check', + 'tls_client_auth', + 'security_header', + 'dnssec', + 'min_tls_version', 'automatic_https_rewrites', - 'image_size_optimization', + 'always_use_https', + 'ipv6', + 'http2', + 'brotli', 'pseudo_ipv4', + 'waf', + 'ssl', + 'true_client_ip_header', + 'cis_id', + 'hotlink_protection', + 'image_load_optimization', + 'script_load_optimization', + 'challenge_ttl', + 'opportunistic_encryption', ] # Params for Data source @@ -293,107 +293,107 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - server_side_exclude=dict( + max_upload=dict( + required=False, + type='int'), + minify=dict( + required=False, + elements='', + type='list'), + ip_geolocation=dict( required=False, type='str'), - true_client_ip_header=dict( + image_size_optimization=dict( required=False, type='str'), - dnssec=dict( + origin_error_page_pass_thru=dict( required=False, type='str'), - waf=dict( + response_buffering=dict( required=False, type='str'), - ipv6=dict( + server_side_exclude=dict( required=False, type='str'), - image_load_optimization=dict( + websockets=dict( required=False, type='str'), - max_upload=dict( + cname_flattening=dict( required=False, - type='int'), - mobile_redirect=dict( + type='str'), + prefetch_preload=dict( + required=False, + type='str'), + cipher=dict( required=False, elements='', type='list'), - opportunistic_encryption=dict( + mobile_redirect=dict( required=False, - type='str'), - brotli=dict( + elements='', + type='list'), + domain_id=dict( required=False, type='str'), - websockets=dict( + browser_check=dict( required=False, type='str'), tls_client_auth=dict( required=False, type='str'), - cis_id=dict( - required=False, - type='str'), - ssl=dict( + security_header=dict( required=False, - type='str'), - browser_check=dict( + elements='', + type='list'), + dnssec=dict( required=False, type='str'), - http2=dict( + min_tls_version=dict( required=False, type='str'), - min_tls_version=dict( + automatic_https_rewrites=dict( required=False, type='str'), always_use_https=dict( required=False, type='str'), - script_load_optimization=dict( + ipv6=dict( required=False, type='str'), - prefetch_preload=dict( + http2=dict( required=False, type='str'), - response_buffering=dict( + brotli=dict( required=False, type='str'), - challenge_ttl=dict( - required=False, - type='int'), - cipher=dict( - required=False, - elements='', - type='list'), - cname_flattening=dict( + pseudo_ipv4=dict( required=False, type='str'), - hotlink_protection=dict( + waf=dict( required=False, type='str'), - ip_geolocation=dict( + ssl=dict( required=False, type='str'), - origin_error_page_pass_thru=dict( + true_client_ip_header=dict( required=False, type='str'), - security_header=dict( - required=False, - elements='', - type='list'), - minify=dict( + cis_id=dict( required=False, - elements='', - type='list'), - domain_id=dict( + type='str'), + hotlink_protection=dict( required=False, type='str'), - automatic_https_rewrites=dict( + image_load_optimization=dict( required=False, type='str'), - image_size_optimization=dict( + script_load_optimization=dict( required=False, type='str'), - pseudo_ipv4=dict( + challenge_ttl=dict( + required=False, + type='int'), + opportunistic_encryption=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cis_edge_functions_trigger.py b/plugins/modules/ibm_cis_edge_functions_trigger.py index ba311e7fc..c5beae57f 100644 --- a/plugins/modules/ibm_cis_edge_functions_trigger.py +++ b/plugins/modules/ibm_cis_edge_functions_trigger.py @@ -22,16 +22,6 @@ - Terraform v0.12.20 options: - pattern_url: - description: - - (Required for new resource) Edge function trigger pattern - required: True - type: str - action_name: - description: - - Edge function trigger action name - required: False - type: str cis_id: description: - (Required for new resource) CIS Intance CRN @@ -42,6 +32,16 @@ - (Required for new resource) CIS Domain ID required: True type: str + pattern_url: + description: + - (Required for new resource) Edge function trigger pattern + required: True + type: str + action_name: + description: + - Edge function trigger action name + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -88,17 +88,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pattern_url', 'str'), ('cis_id', 'str'), ('domain_id', 'str'), + ('pattern_url', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pattern_url', - 'action_name', 'cis_id', 'domain_id', + 'pattern_url', + 'action_name', ] # Params for Data source @@ -115,16 +115,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pattern_url=dict( + cis_id=dict( required=False, type='str'), - action_name=dict( + domain_id=dict( required=False, type='str'), - cis_id=dict( + pattern_url=dict( required=False, type='str'), - domain_id=dict( + action_name=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cis_firewall.py b/plugins/modules/ibm_cis_firewall.py index 166db0f48..1cf6768f3 100644 --- a/plugins/modules/ibm_cis_firewall.py +++ b/plugins/modules/ibm_cis_firewall.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + cis_id: + description: + - (Required for new resource) CIS object id + required: True + type: str + domain_id: + description: + - (Required for new resource) Associated CIS domain + required: True + type: str firewall_type: description: - (Required for new resource) Type of firewall.Allowable values are access-rules,ua-rules,lockdowns @@ -45,16 +55,6 @@ required: False type: list elements: dict - cis_id: - description: - - (Required for new resource) CIS object id - required: True - type: str - domain_id: - description: - - (Required for new resource) Associated CIS domain - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -101,19 +101,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('firewall_type', 'str'), ('cis_id', 'str'), ('domain_id', 'str'), + ('firewall_type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'cis_id', + 'domain_id', 'firewall_type', 'lockdown', 'access_rule', 'ua_rule', - 'cis_id', - 'domain_id', ] # Params for Data source @@ -136,6 +136,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + cis_id=dict( + required=False, + type='str'), + domain_id=dict( + required=False, + type='str'), firewall_type=dict( required=False, type='str'), @@ -151,12 +157,6 @@ required=False, elements='', type='list'), - cis_id=dict( - required=False, - type='str'), - domain_id=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cis_global_load_balancer.py b/plugins/modules/ibm_cis_global_load_balancer.py index b1a2f5cf1..d10a87a2f 100644 --- a/plugins/modules/ibm_cis_global_load_balancer.py +++ b/plugins/modules/ibm_cis_global_load_balancer.py @@ -22,59 +22,36 @@ - Terraform v0.12.20 options: - description: + enabled: description: - - Description for the load balancer instance + - set to true of LB needs to enabled required: False - type: str + type: bool + default: True cis_id: description: - (Required for new resource) CIS instance crn required: True type: str - fallback_pool_id: + domain_id: description: - - (Required for new resource) fallback pool ID + - (Required for new resource) Associated CIS domain required: True type: str - ttl: - description: - - TTL value - required: False - type: int - default: 60 - proxied: + description: description: - - set to true if proxy needs to be enabled + - Description for the load balancer instance required: False - type: bool - default: False + type: str session_affinity: description: - Session affinity info required: False type: str default: none - enabled: - description: - - set to true of LB needs to enabled - required: False - type: bool - default: True - region_pools: - description: - - None - required: False - type: list - elements: dict - domain_id: - description: - - (Required for new resource) Associated CIS domain - required: True - type: str - name: + fallback_pool_id: description: - - (Required for new resource) name + - (Required for new resource) fallback pool ID required: True type: str default_pool_ids: @@ -83,10 +60,16 @@ required: True type: list elements: str - steering_policy: + ttl: description: - - Steering policy info + - TTL value required: False + type: int + default: 60 + name: + description: + - (Required for new resource) name + required: True type: str pop_pools: description: @@ -94,6 +77,23 @@ required: False type: list elements: dict + region_pools: + description: + - None + required: False + type: list + elements: dict + steering_policy: + description: + - Steering policy info + required: False + type: str + proxied: + description: + - set to true if proxy needs to be enabled + required: False + type: bool + default: False id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -141,27 +141,27 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('cis_id', 'str'), - ('fallback_pool_id', 'str'), ('domain_id', 'str'), - ('name', 'str'), + ('fallback_pool_id', 'str'), ('default_pool_ids', 'list'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'description', + 'enabled', 'cis_id', + 'domain_id', + 'description', + 'session_affinity', 'fallback_pool_id', + 'default_pool_ids', 'ttl', - 'proxied', - 'session_affinity', - 'enabled', - 'region_pools', - 'domain_id', 'name', - 'default_pool_ids', - 'steering_policy', 'pop_pools', + 'region_pools', + 'steering_policy', + 'proxied', ] # Params for Data source @@ -180,48 +180,48 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - description=dict( + enabled=dict( required=False, - type='str'), + type='bool'), cis_id=dict( required=False, type='str'), - fallback_pool_id=dict( + domain_id=dict( required=False, type='str'), - ttl=dict( - required=False, - type='int'), - proxied=dict( + description=dict( required=False, - type='bool'), + type='str'), session_affinity=dict( required=False, type='str'), - enabled=dict( + fallback_pool_id=dict( required=False, - type='bool'), - region_pools=dict( + type='str'), + default_pool_ids=dict( required=False, elements='', type='list'), - domain_id=dict( + ttl=dict( required=False, - type='str'), + type='int'), name=dict( required=False, type='str'), - default_pool_ids=dict( + pop_pools=dict( + required=False, + elements='', + type='list'), + region_pools=dict( required=False, elements='', type='list'), steering_policy=dict( required=False, type='str'), - pop_pools=dict( + proxied=dict( required=False, - elements='', - type='list'), + type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cis_healthcheck.py b/plugins/modules/ibm_cis_healthcheck.py index 529709029..023dadfa3 100644 --- a/plugins/modules/ibm_cis_healthcheck.py +++ b/plugins/modules/ibm_cis_healthcheck.py @@ -22,51 +22,34 @@ - Terraform v0.12.20 options: - follow_redirects: - description: - - follow_redirects - required: False - type: bool - default: False - retries: - description: - - retries - required: False - type: int - default: 2 - interval: - description: - - interval - required: False - type: int - default: 60 - port: - description: - - port number - required: False - type: int expected_body: description: - expected_body required: False type: str - expected_codes: + description: description: - - expected_codes + - description required: False type: str + default: method: description: - method required: False type: str default: GET - description: + follow_redirects: description: - - description + - follow_redirects required: False - type: str - default: + type: bool + default: False + port: + description: + - port number + required: False + type: int allow_insecure: description: - allow_insecure @@ -90,6 +73,17 @@ required: False type: str default: / + retries: + description: + - retries + required: False + type: int + default: 2 + expected_codes: + description: + - expected_codes + required: False + type: str type: description: - type @@ -102,6 +96,12 @@ required: False type: int default: 5 + interval: + description: + - interval + required: False + type: int + default: 60 id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -153,20 +153,20 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'follow_redirects', - 'retries', - 'interval', - 'port', 'expected_body', - 'expected_codes', - 'method', 'description', + 'method', + 'follow_redirects', + 'port', 'allow_insecure', 'headers', 'cis_id', 'path', + 'retries', + 'expected_codes', 'type', 'timeout', + 'interval', ] # Params for Data source @@ -183,30 +183,21 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - follow_redirects=dict( - required=False, - type='bool'), - retries=dict( - required=False, - type='int'), - interval=dict( - required=False, - type='int'), - port=dict( - required=False, - type='int'), expected_body=dict( required=False, type='str'), - expected_codes=dict( + description=dict( required=False, type='str'), method=dict( required=False, type='str'), - description=dict( + follow_redirects=dict( required=False, - type='str'), + type='bool'), + port=dict( + required=False, + type='int'), allow_insecure=dict( required=False, type='bool'), @@ -220,12 +211,21 @@ path=dict( required=False, type='str'), + retries=dict( + required=False, + type='int'), + expected_codes=dict( + required=False, + type='str'), type=dict( required=False, type='str'), timeout=dict( required=False, type='int'), + interval=dict( + required=False, + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cis_origin_pool.py b/plugins/modules/ibm_cis_origin_pool.py index 9c31afa34..3d936652e 100644 --- a/plugins/modules/ibm_cis_origin_pool.py +++ b/plugins/modules/ibm_cis_origin_pool.py @@ -22,54 +22,54 @@ - Terraform v0.12.20 options: + cis_id: + description: + - (Required for new resource) CIS instance crn + required: True + type: str + description: + description: + - Description of the CIS Origin Pool + required: False + type: str + name: + description: + - (Required for new resource) name + required: True + type: str minimum_origins: description: - Minimum number of Origins required: False type: int default: 1 + origins: + description: + - (Required for new resource) Origins info + required: True + type: list + elements: dict check_regions: description: - (Required for new resource) List of regions required: True type: list elements: str - monitor: - description: - - Monitor value - required: False - type: str - cis_id: - description: - - (Required for new resource) CIS instance crn - required: True - type: str - description: - description: - - Description of the CIS Origin Pool - required: False - type: str enabled: description: - (Required for new resource) Boolean value set to true if cis origin pool needs to be enabled required: True type: bool - notification_email: + monitor: description: - - Email address configured to recieve the notifications + - Monitor value required: False type: str - name: + notification_email: description: - - (Required for new resource) name - required: True + - Email address configured to recieve the notifications + required: False type: str - origins: - description: - - (Required for new resource) Origins info - required: True - type: list - elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -116,24 +116,24 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('check_regions', 'list'), ('cis_id', 'str'), - ('enabled', 'bool'), ('name', 'str'), ('origins', 'list'), + ('check_regions', 'list'), + ('enabled', 'bool'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'minimum_origins', - 'check_regions', - 'monitor', 'cis_id', 'description', - 'enabled', - 'notification_email', 'name', + 'minimum_origins', 'origins', + 'check_regions', + 'enabled', + 'monitor', + 'notification_email', ] # Params for Data source @@ -150,35 +150,35 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + cis_id=dict( + required=False, + type='str'), + description=dict( + required=False, + type='str'), + name=dict( + required=False, + type='str'), minimum_origins=dict( required=False, type='int'), - check_regions=dict( + origins=dict( required=False, elements='', type='list'), - monitor=dict( - required=False, - type='str'), - cis_id=dict( - required=False, - type='str'), - description=dict( + check_regions=dict( required=False, - type='str'), + elements='', + type='list'), enabled=dict( required=False, type='bool'), - notification_email=dict( + monitor=dict( required=False, type='str'), - name=dict( + notification_email=dict( required=False, type='str'), - origins=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cis_page_rule.py b/plugins/modules/ibm_cis_page_rule.py index 0bd584a2e..528c4da8f 100644 --- a/plugins/modules/ibm_cis_page_rule.py +++ b/plugins/modules/ibm_cis_page_rule.py @@ -22,6 +22,12 @@ - Terraform v0.12.20 options: + actions: + description: + - (Required for new resource) Page rule actions + required: True + type: list + elements: dict cis_id: description: - (Required for new resource) CIS instance crn @@ -50,12 +56,6 @@ required: True type: list elements: dict - actions: - description: - - (Required for new resource) Page rule actions - required: True - type: list - elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -102,20 +102,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('actions', 'list'), ('cis_id', 'str'), ('domain_id', 'str'), ('targets', 'list'), - ('actions', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'actions', 'cis_id', 'domain_id', 'priority', 'status', 'targets', - 'actions', ] # Params for Data source @@ -132,6 +132,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + actions=dict( + required=False, + elements='', + type='list'), cis_id=dict( required=False, type='str'), @@ -148,10 +152,6 @@ required=False, elements='', type='list'), - actions=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cis_page_rules_info.py b/plugins/modules/ibm_cis_page_rules_info.py index 82373e336..50e6aad82 100644 --- a/plugins/modules/ibm_cis_page_rules_info.py +++ b/plugins/modules/ibm_cis_page_rules_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - cis_id: + domain_id: description: - - DNS Zone CRN + - DNS Zone ID required: True type: str - domain_id: + cis_id: description: - - DNS Zone ID + - DNS Zone CRN required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('cis_id', 'str'), ('domain_id', 'str'), + ('cis_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'cis_id', 'domain_id', + 'cis_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - cis_id=dict( + domain_id=dict( required=True, type='str'), - domain_id=dict( + cis_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_cis_range_app.py b/plugins/modules/ibm_cis_range_app.py index 877e24cac..ac7c456bd 100644 --- a/plugins/modules/ibm_cis_range_app.py +++ b/plugins/modules/ibm_cis_range_app.py @@ -22,16 +22,26 @@ - Terraform v0.12.20 options: + origin_dns: + description: + - DNS record pointing to the origin for this Range application. + required: False + type: str traffic_type: description: - Configure how traffic is handled at the edge. required: False type: str default: direct - cis_id: + origin_port: description: - - (Required for new resource) CIS Intance CRN - required: True + - Port at the origin that listens to traffic + required: False + type: int + proxy_protocol: + description: + - Allows for the true client IP to be passed to the service. + required: False type: str domain_id: description: @@ -43,17 +53,11 @@ - (Required for new resource) Defines the protocol and port for this application required: True type: str - edge_ips_connectivity: + dns: description: - - Specifies the IP version. - required: False + - (Required for new resource) Name of the DNS record for this application + required: True type: str - default: all - ip_firewall: - description: - - Enables the IP Firewall for this application. Only available for TCP applications. - required: False - type: bool dns_type: description: - (Required for new resource) Type of the DNS record for this application @@ -65,38 +69,34 @@ required: False type: list elements: str - origin_dns: + tls: description: - - DNS record pointing to the origin for this Range application. + - Configure if and how TLS connections are terminated at the edge. required: False type: str - dns: + default: off + cis_id: description: - - (Required for new resource) Name of the DNS record for this application + - (Required for new resource) CIS Intance CRN required: True type: str - proxy_protocol: + ip_firewall: description: - - Allows for the true client IP to be passed to the service. + - Enables the IP Firewall for this application. Only available for TCP applications. required: False - type: str + type: bool edge_ips_type: description: - The type of edge IP configuration. required: False type: str default: dynamic - origin_port: - description: - - Port at the origin that listens to traffic - required: False - type: int - tls: + edge_ips_connectivity: description: - - Configure if and how TLS connections are terminated at the edge. + - Specifies the IP version. required: False type: str - default: off + default: all id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -143,29 +143,29 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('cis_id', 'str'), ('domain_id', 'str'), ('protocol', 'str'), - ('dns_type', 'str'), ('dns', 'str'), + ('dns_type', 'str'), + ('cis_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'origin_dns', 'traffic_type', - 'cis_id', + 'origin_port', + 'proxy_protocol', 'domain_id', 'protocol', - 'edge_ips_connectivity', - 'ip_firewall', + 'dns', 'dns_type', 'origin_direct', - 'origin_dns', - 'dns', - 'proxy_protocol', - 'edge_ips_type', - 'origin_port', 'tls', + 'cis_id', + 'ip_firewall', + 'edge_ips_type', + 'edge_ips_connectivity', ] # Params for Data source @@ -183,10 +183,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + origin_dns=dict( + required=False, + type='str'), traffic_type=dict( required=False, type='str'), - cis_id=dict( + origin_port=dict( + required=False, + type='int'), + proxy_protocol=dict( required=False, type='str'), domain_id=dict( @@ -195,12 +201,9 @@ protocol=dict( required=False, type='str'), - edge_ips_connectivity=dict( + dns=dict( required=False, type='str'), - ip_firewall=dict( - required=False, - type='bool'), dns_type=dict( required=False, type='str'), @@ -208,22 +211,19 @@ required=False, elements='', type='list'), - origin_dns=dict( + tls=dict( required=False, type='str'), - dns=dict( + cis_id=dict( required=False, type='str'), - proxy_protocol=dict( + ip_firewall=dict( required=False, - type='str'), + type='bool'), edge_ips_type=dict( required=False, type='str'), - origin_port=dict( - required=False, - type='int'), - tls=dict( + edge_ips_connectivity=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cis_rate_limit.py b/plugins/modules/ibm_cis_rate_limit.py index b8323ecc0..0e088697a 100644 --- a/plugins/modules/ibm_cis_rate_limit.py +++ b/plugins/modules/ibm_cis_rate_limit.py @@ -27,53 +27,53 @@ - (Required for new resource) CIS Intance CRN required: True type: str - domain_id: - description: - - (Required for new resource) CIS Domain ID - required: True - type: str - description: + bypass: description: - - A note that you can use to describe the reason for a rate limiting rule. + - Bypass URL required: False - type: str - period: + type: list + elements: dict + threshold: description: - - (Required for new resource) Rate Limiting Period + - (Required for new resource) Rate Limiting Threshold required: True type: int - correlate: - description: - - Ratelimiting Correlate - required: False - type: list - elements: dict action: description: - (Required for new resource) Rate Limiting Action required: True type: list elements: dict + match: + description: + - Rate Limiting Match + required: False + type: list + elements: dict + domain_id: + description: + - (Required for new resource) CIS Domain ID + required: True + type: str disabled: description: - Whether this rate limiting rule is currently disabled. required: False type: bool default: False - bypass: + description: description: - - Bypass URL + - A note that you can use to describe the reason for a rate limiting rule. required: False - type: list - elements: dict - threshold: + type: str + period: description: - - (Required for new resource) Rate Limiting Threshold + - (Required for new resource) Rate Limiting Period required: True type: int - match: + correlate: description: - - Rate Limiting Match + - Ratelimiting Correlate required: False type: list elements: dict @@ -124,24 +124,24 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('cis_id', 'str'), + ('threshold', 'int'), + ('action', 'list'), ('domain_id', 'str'), ('period', 'int'), - ('action', 'list'), - ('threshold', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'cis_id', + 'bypass', + 'threshold', + 'action', + 'match', 'domain_id', + 'disabled', 'description', 'period', 'correlate', - 'action', - 'disabled', - 'bypass', - 'threshold', - 'match', ] # Params for Data source @@ -165,34 +165,34 @@ cis_id=dict( required=False, type='str'), - domain_id=dict( - required=False, - type='str'), - description=dict( + bypass=dict( required=False, - type='str'), - period=dict( + elements='', + type='list'), + threshold=dict( required=False, type='int'), - correlate=dict( + action=dict( required=False, elements='', type='list'), - action=dict( + match=dict( required=False, elements='', type='list'), + domain_id=dict( + required=False, + type='str'), disabled=dict( required=False, type='bool'), - bypass=dict( + description=dict( required=False, - elements='', - type='list'), - threshold=dict( + type='str'), + period=dict( required=False, type='int'), - match=dict( + correlate=dict( required=False, elements='', type='list'), diff --git a/plugins/modules/ibm_cis_waf_group.py b/plugins/modules/ibm_cis_waf_group.py index ac6a49012..62d34c041 100644 --- a/plugins/modules/ibm_cis_waf_group.py +++ b/plugins/modules/ibm_cis_waf_group.py @@ -27,14 +27,14 @@ - (Required for new resource) CIS Intance CRN required: True type: str - mode: + domain_id: description: - - (Required for new resource) WAF Rule group mode on/off + - (Required for new resource) CIS Domain ID required: True type: str - domain_id: + group_id: description: - - (Required for new resource) CIS Domain ID + - (Required for new resource) WAF Rule group id required: True type: str package_id: @@ -42,9 +42,9 @@ - (Required for new resource) WAF Rule package id required: True type: str - group_id: + mode: description: - - (Required for new resource) WAF Rule group id + - (Required for new resource) WAF Rule group mode on/off required: True type: str id: @@ -94,19 +94,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('cis_id', 'str'), - ('mode', 'str'), ('domain_id', 'str'), - ('package_id', 'str'), ('group_id', 'str'), + ('package_id', 'str'), + ('mode', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'cis_id', - 'mode', 'domain_id', - 'package_id', 'group_id', + 'package_id', + 'mode', ] # Params for Data source @@ -126,16 +126,16 @@ cis_id=dict( required=False, type='str'), - mode=dict( + domain_id=dict( required=False, type='str'), - domain_id=dict( + group_id=dict( required=False, type='str'), package_id=dict( required=False, type='str'), - group_id=dict( + mode=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cis_waf_groups_info.py b/plugins/modules/ibm_cis_waf_groups_info.py index 177d665ce..39dd508ec 100644 --- a/plugins/modules/ibm_cis_waf_groups_info.py +++ b/plugins/modules/ibm_cis_waf_groups_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + domain_id: + description: + - CIS Domain ID + required: True + type: str package_id: description: - WAF Rule package id @@ -31,11 +36,6 @@ - CIS Intance CRN required: True type: str - domain_id: - description: - - CIS Domain ID - required: True - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -69,16 +69,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('domain_id', 'str'), ('package_id', 'str'), ('cis_id', 'str'), - ('domain_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'domain_id', 'package_id', 'cis_id', - 'domain_id', ] @@ -89,13 +89,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - package_id=dict( + domain_id=dict( required=True, type='str'), - cis_id=dict( + package_id=dict( required=True, type='str'), - domain_id=dict( + cis_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_cis_waf_package.py b/plugins/modules/ibm_cis_waf_package.py index 2671d0327..7e2ae23e2 100644 --- a/plugins/modules/ibm_cis_waf_package.py +++ b/plugins/modules/ibm_cis_waf_package.py @@ -22,29 +22,29 @@ - Terraform v0.12.20 options: - cis_id: + sensitivity: description: - - (Required for new resource) CIS Intance CRN + - (Required for new resource) WAF pakcage sensitivity required: True type: str - domain_id: + action_mode: description: - - (Required for new resource) CIS Domain ID + - (Required for new resource) WAF pakcage action mode required: True type: str - package_id: + cis_id: description: - - (Required for new resource) WAF pakcage ID + - (Required for new resource) CIS Intance CRN required: True type: str - sensitivity: + domain_id: description: - - (Required for new resource) WAF pakcage sensitivity + - (Required for new resource) CIS Domain ID required: True type: str - action_mode: + package_id: description: - - (Required for new resource) WAF pakcage action mode + - (Required for new resource) WAF pakcage ID required: True type: str id: @@ -93,20 +93,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('sensitivity', 'str'), + ('action_mode', 'str'), ('cis_id', 'str'), ('domain_id', 'str'), ('package_id', 'str'), - ('sensitivity', 'str'), - ('action_mode', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'sensitivity', + 'action_mode', 'cis_id', 'domain_id', 'package_id', - 'sensitivity', - 'action_mode', ] # Params for Data source @@ -123,19 +123,19 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - cis_id=dict( + sensitivity=dict( required=False, type='str'), - domain_id=dict( + action_mode=dict( required=False, type='str'), - package_id=dict( + cis_id=dict( required=False, type='str'), - sensitivity=dict( + domain_id=dict( required=False, type='str'), - action_mode=dict( + package_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cis_waf_rule.py b/plugins/modules/ibm_cis_waf_rule.py index b8f292717..d3818c98c 100644 --- a/plugins/modules/ibm_cis_waf_rule.py +++ b/plugins/modules/ibm_cis_waf_rule.py @@ -27,24 +27,24 @@ - (Required for new resource) CIS Domain ID required: True type: str - package_id: + rule_id: description: - - (Required for new resource) CIS WAF Rule package id + - (Required for new resource) CIS WAF Rule id required: True type: str - cis_id: + package_id: description: - - (Required for new resource) CIS Intance CRN + - (Required for new resource) CIS WAF Rule package id required: True type: str - rule_id: + mode: description: - - (Required for new resource) CIS WAF Rule id + - (Required for new resource) CIS WAF Rule mode required: True type: str - mode: + cis_id: description: - - (Required for new resource) CIS WAF Rule mode + - (Required for new resource) CIS Intance CRN required: True type: str id: @@ -94,19 +94,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('domain_id', 'str'), - ('package_id', 'str'), - ('cis_id', 'str'), ('rule_id', 'str'), + ('package_id', 'str'), ('mode', 'str'), + ('cis_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'domain_id', - 'package_id', - 'cis_id', 'rule_id', + 'package_id', 'mode', + 'cis_id', ] # Params for Data source @@ -126,16 +126,16 @@ domain_id=dict( required=False, type='str'), - package_id=dict( + rule_id=dict( required=False, type='str'), - cis_id=dict( + package_id=dict( required=False, type='str'), - rule_id=dict( + mode=dict( required=False, type='str'), - mode=dict( + cis_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cloud_shell_account_settings.py b/plugins/modules/ibm_cloud_shell_account_settings.py index dc97f410b..115ae3ea7 100644 --- a/plugins/modules/ibm_cloud_shell_account_settings.py +++ b/plugins/modules/ibm_cloud_shell_account_settings.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + account_id: + description: + - (Required for new resource) The account ID in which the account settings belong to. + required: True + type: str + rev: + description: + - Unique revision number for the settings object. + required: False + type: str default_enable_new_features: description: - You can choose which Cloud Shell features are available in the account and whether any new features are enabled as they become available. The feature settings apply only to the enabled Cloud Shell locations. @@ -43,16 +53,6 @@ required: False type: list elements: dict - account_id: - description: - - (Required for new resource) The account ID in which the account settings belong to. - required: True - type: str - rev: - description: - - Unique revision number for the settings object. - required: False - type: str regions: description: - List of Cloud Shell region settings. @@ -110,12 +110,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'account_id', + 'rev', 'default_enable_new_features', 'default_enable_new_regions', 'enabled', 'features', - 'account_id', - 'rev', 'regions', ] @@ -135,6 +135,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + account_id=dict( + required=False, + type='str'), + rev=dict( + required=False, + type='str'), default_enable_new_features=dict( required=False, type='bool'), @@ -148,12 +154,6 @@ required=False, elements='', type='list'), - account_id=dict( - required=False, - type='str'), - rev=dict( - required=False, - type='str'), regions=dict( required=False, elements='', diff --git a/plugins/modules/ibm_cloudant.py b/plugins/modules/ibm_cloudant.py index efecfaa60..5fc6039a1 100644 --- a/plugins/modules/ibm_cloudant.py +++ b/plugins/modules/ibm_cloudant.py @@ -22,51 +22,51 @@ - Terraform v0.12.20 options: - resource_group_id: - description: - - The resource group id - required: False - type: str plan: description: - (Required for new resource) The plan type of the service required: True type: str - include_data_events: + service_endpoints: description: - - Include data event types in events sent to IBM Cloud Activity Tracker with LogDNA for the IBM Cloudant instance. By default only emitted events are of "management" type. + - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. required: False - type: bool - default: False + type: str cors_config: description: - Configuration for CORS. required: False type: list elements: dict - location: + environment_crn: description: - - (Required for new resource) The location where the instance available + - CRN of the IBM Cloudant Dedicated Hardware plan instance + required: False + type: str + name: + description: + - (Required for new resource) A name for the resource instance required: True type: str - environment_crn: + legacy_credentials: description: - - CRN of the IBM Cloudant Dedicated Hardware plan instance + - Use both legacy credentials and IAM for authentication required: False + type: bool + default: False + location: + description: + - (Required for new resource) The location where the instance available + required: True type: str parameters: description: - Arbitrary parameters to pass. Must be a JSON object required: False type: dict - parameters_json: - description: - - Arbitrary parameters to pass in Json string format - required: False - type: str - legacy_credentials: + include_data_events: description: - - Use both legacy credentials and IAM for authentication + - Include data event types in events sent to IBM Cloud Activity Tracker with LogDNA for the IBM Cloudant instance. By default only emitted events are of "management" type. required: False type: bool default: False @@ -76,28 +76,28 @@ required: False type: int default: 1 - name: + enable_cors: description: - - (Required for new resource) A name for the resource instance - required: True - type: str - tags: + - Boolean value to turn CORS on and off. + required: False + type: bool + default: True + resource_group_id: description: - - None + - The resource group id required: False - type: list - elements: str - service_endpoints: + type: str + parameters_json: description: - - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. + - Arbitrary parameters to pass in Json string format required: False type: str - enable_cors: + tags: description: - - Boolean value to turn CORS on and off. + - None required: False - type: bool - default: True + type: list + elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -145,26 +145,26 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('plan', 'str'), - ('location', 'str'), ('name', 'str'), + ('location', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'resource_group_id', 'plan', - 'include_data_events', + 'service_endpoints', 'cors_config', - 'location', 'environment_crn', - 'parameters', - 'parameters_json', + 'name', 'legacy_credentials', + 'location', + 'parameters', + 'include_data_events', 'capacity', - 'name', - 'tags', - 'service_endpoints', 'enable_cors', + 'resource_group_id', + 'parameters_json', + 'tags', ] # Params for Data source @@ -187,50 +187,50 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - resource_group_id=dict( - required=False, - type='str'), plan=dict( required=False, type='str'), - include_data_events=dict( + service_endpoints=dict( required=False, - type='bool'), + type='str'), cors_config=dict( required=False, elements='', type='list'), - location=dict( + environment_crn=dict( required=False, type='str'), - environment_crn=dict( + name=dict( required=False, type='str'), - parameters=dict( + legacy_credentials=dict( required=False, - type='dict'), - parameters_json=dict( + type='bool'), + location=dict( required=False, type='str'), - legacy_credentials=dict( + parameters=dict( + required=False, + type='dict'), + include_data_events=dict( required=False, type='bool'), capacity=dict( required=False, type='int'), - name=dict( + enable_cors=dict( + required=False, + type='bool'), + resource_group_id=dict( + required=False, + type='str'), + parameters_json=dict( required=False, type='str'), tags=dict( required=False, elements='', type='list'), - service_endpoints=dict( - required=False, - type='str'), - enable_cors=dict( - required=False, - type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cm_catalog.py b/plugins/modules/ibm_cm_catalog.py index f5bde56bf..60566460b 100644 --- a/plugins/modules/ibm_cm_catalog.py +++ b/plugins/modules/ibm_cm_catalog.py @@ -22,21 +22,20 @@ - Terraform v0.12.20 options: - kind: + catalog_icon_url: description: - - Kind of catalog, offering or vpe. + - URL for an icon associated with this catalog. required: False type: str - default: offering short_description: description: - Description in the requested language. required: False type: str - catalog_icon_url: + label: description: - - URL for an icon associated with this catalog. - required: False + - (Required for new resource) Display Name in the requested language. + required: True type: str tags: description: @@ -44,16 +43,17 @@ required: False type: list elements: str - label: - description: - - (Required for new resource) Display Name in the requested language. - required: True - type: str resource_group_id: description: - Resource Group ID required: False type: str + kind: + description: + - Kind of catalog, offering or vpe. + required: False + type: str + default: offering id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -105,12 +105,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'kind', - 'short_description', 'catalog_icon_url', - 'tags', + 'short_description', 'label', + 'tags', 'resource_group_id', + 'kind', ] # Params for Data source @@ -129,23 +129,23 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - kind=dict( + catalog_icon_url=dict( required=False, type='str'), short_description=dict( required=False, type='str'), - catalog_icon_url=dict( + label=dict( required=False, type='str'), tags=dict( required=False, elements='', type='list'), - label=dict( + resource_group_id=dict( required=False, type='str'), - resource_group_id=dict( + kind=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_cm_offering.py b/plugins/modules/ibm_cm_offering.py index ab349ca9e..4cc7145e9 100644 --- a/plugins/modules/ibm_cm_offering.py +++ b/plugins/modules/ibm_cm_offering.py @@ -22,22 +22,22 @@ - Terraform v0.12.20 options: - catalog_id: + tags: description: - - (Required for new resource) The id of the catalog containing this offering. - required: True - type: str + - List of tags associated with this catalog. + required: False + type: list + elements: str label: description: - (Required for new resource) Display Name in the requested language. required: True type: str - tags: + catalog_id: description: - - List of tags associated with this catalog. - required: False - type: list - elements: str + - (Required for new resource) The id of the catalog containing this offering. + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -84,15 +84,15 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('catalog_id', 'str'), ('label', 'str'), + ('catalog_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'catalog_id', - 'label', 'tags', + 'label', + 'catalog_id', ] # Params for Data source @@ -113,16 +113,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - catalog_id=dict( + tags=dict( required=False, - type='str'), + elements='', + type='list'), label=dict( required=False, type='str'), - tags=dict( + catalog_id=dict( required=False, - elements='', - type='list'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cm_offering_instance.py b/plugins/modules/ibm_cm_offering_instance.py index d4e72e07d..91a763830 100644 --- a/plugins/modules/ibm_cm_offering_instance.py +++ b/plugins/modules/ibm_cm_offering_instance.py @@ -22,73 +22,73 @@ - Terraform v0.12.20 options: - cluster_namespaces: - description: - - (Required for new resource) List of target namespaces to install into. - required: True - type: list - elements: str - label: + cluster_id: description: - - (Required for new resource) the label for this instance. + - (Required for new resource) Cluster ID. required: True type: str - version: + cluster_all_namespaces: description: - - (Required for new resource) The version this instance was installed from (not version id). + - (Required for new resource) designate to install into all namespaces. required: True - type: str + type: bool catalog_id: description: - (Required for new resource) Catalog ID this instance was created from. required: True type: str - cluster_region: - description: - - (Required for new resource) Cluster region (e.g., us-south). - required: True - type: str resource_group_id: description: - id of the resource group required: False type: str - install_plan: - description: - - install plan for the subscription of the operator- can be either automatic or manual. Required for operator bundles - required: False - type: str channel: description: - channel to target for the operator subscription. Required for operator bundles required: False type: str - wait_until_successful: - description: - - Whether to wait until the offering instance successfully provisions, or to return when accepted - required: False - type: bool - default: True - cluster_id: + label: description: - - (Required for new resource) Cluster ID. + - (Required for new resource) the label for this instance. required: True type: str - cluster_all_namespaces: - description: - - (Required for new resource) designate to install into all namespaces. - required: True - type: bool offering_id: description: - (Required for new resource) Offering ID this instance was created from. required: True type: str + cluster_namespaces: + description: + - (Required for new resource) List of target namespaces to install into. + required: True + type: list + elements: str kind_format: description: - (Required for new resource) the format this instance has (helm, operator, ova...). required: True type: str + version: + description: + - (Required for new resource) The version this instance was installed from (not version id). + required: True + type: str + cluster_region: + description: + - (Required for new resource) Cluster region (e.g., us-south). + required: True + type: str + install_plan: + description: + - install plan for the subscription of the operator- can be either automatic or manual. Required for operator bundles + required: False + type: str + wait_until_successful: + description: + - Whether to wait until the offering instance successfully provisions, or to return when accepted + required: False + type: bool + default: True id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -135,32 +135,32 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('cluster_namespaces', 'list'), - ('label', 'str'), - ('version', 'str'), - ('catalog_id', 'str'), - ('cluster_region', 'str'), ('cluster_id', 'str'), ('cluster_all_namespaces', 'bool'), + ('catalog_id', 'str'), + ('label', 'str'), ('offering_id', 'str'), + ('cluster_namespaces', 'list'), ('kind_format', 'str'), + ('version', 'str'), + ('cluster_region', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'cluster_namespaces', - 'label', - 'version', + 'cluster_id', + 'cluster_all_namespaces', 'catalog_id', - 'cluster_region', 'resource_group_id', - 'install_plan', 'channel', - 'wait_until_successful', - 'cluster_id', - 'cluster_all_namespaces', + 'label', 'offering_id', + 'cluster_namespaces', 'kind_format', + 'version', + 'cluster_region', + 'install_plan', + 'wait_until_successful', ] # Params for Data source @@ -179,46 +179,46 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - cluster_namespaces=dict( - required=False, - elements='', - type='list'), - label=dict( + cluster_id=dict( required=False, type='str'), - version=dict( + cluster_all_namespaces=dict( required=False, - type='str'), + type='bool'), catalog_id=dict( required=False, type='str'), - cluster_region=dict( + resource_group_id=dict( required=False, type='str'), - resource_group_id=dict( + channel=dict( required=False, type='str'), - install_plan=dict( + label=dict( required=False, type='str'), - channel=dict( + offering_id=dict( required=False, type='str'), - wait_until_successful=dict( + cluster_namespaces=dict( required=False, - type='bool'), - cluster_id=dict( + elements='', + type='list'), + kind_format=dict( required=False, type='str'), - cluster_all_namespaces=dict( + version=dict( required=False, - type='bool'), - offering_id=dict( + type='str'), + cluster_region=dict( required=False, type='str'), - kind_format=dict( + install_plan=dict( required=False, type='str'), + wait_until_successful=dict( + required=False, + type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cm_version.py b/plugins/modules/ibm_cm_version.py index 137d230dc..6c29b3bb4 100644 --- a/plugins/modules/ibm_cm_version.py +++ b/plugins/modules/ibm_cm_version.py @@ -27,38 +27,38 @@ - (Required for new resource) Catalog identifier. required: True type: str - offering_id: + content: description: - - (Required for new resource) Offering identification. - required: True + - byte array representing the content to be imported. Only supported for OVA images at this time. + required: False type: str zipurl: description: - URL path to zip location. If not specified, must provide content in the body of this call. required: False type: str + tags: + description: + - Tags array. + required: False + type: list + elements: str target_version: description: - The semver value for this new version, if not found in the zip url package content. required: False type: str + offering_id: + description: + - (Required for new resource) Offering identification. + required: True + type: str target_kinds: description: - Target kinds. Current valid values are 'iks', 'roks', 'vcenter', and 'terraform'. required: False type: list elements: str - tags: - description: - - Tags array. - required: False - type: list - elements: str - content: - description: - - byte array representing the content to be imported. Only supported for OVA images at this time. - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -112,12 +112,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'catalog_identifier', - 'offering_id', + 'content', 'zipurl', + 'tags', 'target_version', + 'offering_id', 'target_kinds', - 'tags', - 'content', ] # Params for Data source @@ -139,26 +139,26 @@ catalog_identifier=dict( required=False, type='str'), - offering_id=dict( + content=dict( required=False, type='str'), zipurl=dict( required=False, type='str'), + tags=dict( + required=False, + elements='', + type='list'), target_version=dict( required=False, type='str'), - target_kinds=dict( + offering_id=dict( required=False, - elements='', - type='list'), - tags=dict( + type='str'), + target_kinds=dict( required=False, elements='', type='list'), - content=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_autoscale_group.py b/plugins/modules/ibm_compute_autoscale_group.py index 2cf2819c2..93e94e811 100644 --- a/plugins/modules/ibm_compute_autoscale_group.py +++ b/plugins/modules/ibm_compute_autoscale_group.py @@ -22,54 +22,43 @@ - Terraform v0.12.20 options: - port: + minimum_member_count: description: - - Port number - required: False + - (Required for new resource) Minimum member count + required: True type: int health_check: description: - None required: False type: dict - network_vlan_ids: + tags: description: - - List of network VLAN ids + - List of tags required: False type: list - elements: int - name: - description: - - (Required for new resource) Name - required: True - type: str - minimum_member_count: - description: - - (Required for new resource) Minimum member count - required: True - type: int - cooldown: - description: - - (Required for new resource) Cooldown value - required: True - type: int + elements: str virtual_server_id: description: - virtual server ID required: False type: int + port: + description: + - Port number + required: False + type: int virtual_guest_member_template: description: - (Required for new resource) Virtual guest member template required: True type: list elements: dict - tags: + name: description: - - List of tags - required: False - type: list - elements: str + - (Required for new resource) Name + required: True + type: str regional_group: description: - (Required for new resource) regional group @@ -80,11 +69,22 @@ - (Required for new resource) Maximum member count required: True type: int + cooldown: + description: + - (Required for new resource) Cooldown value + required: True + type: int termination_policy: description: - (Required for new resource) Termination policy required: True type: str + network_vlan_ids: + description: + - List of network VLAN ids + required: False + type: list + elements: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -131,29 +131,29 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('minimum_member_count', 'int'), - ('cooldown', 'int'), ('virtual_guest_member_template', 'list'), + ('name', 'str'), ('regional_group', 'str'), ('maximum_member_count', 'int'), + ('cooldown', 'int'), ('termination_policy', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'port', - 'health_check', - 'network_vlan_ids', - 'name', 'minimum_member_count', - 'cooldown', + 'health_check', + 'tags', 'virtual_server_id', + 'port', 'virtual_guest_member_template', - 'tags', + 'name', 'regional_group', 'maximum_member_count', + 'cooldown', 'termination_policy', + 'network_vlan_ids', ] # Params for Data source @@ -170,45 +170,45 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - port=dict( + minimum_member_count=dict( required=False, type='int'), health_check=dict( required=False, type='dict'), - network_vlan_ids=dict( + tags=dict( required=False, elements='', type='list'), - name=dict( - required=False, - type='str'), - minimum_member_count=dict( - required=False, - type='int'), - cooldown=dict( + virtual_server_id=dict( required=False, type='int'), - virtual_server_id=dict( + port=dict( required=False, type='int'), virtual_guest_member_template=dict( required=False, elements='', type='list'), - tags=dict( + name=dict( required=False, - elements='', - type='list'), + type='str'), regional_group=dict( required=False, type='str'), maximum_member_count=dict( required=False, type='int'), + cooldown=dict( + required=False, + type='int'), termination_policy=dict( required=False, type='str'), + network_vlan_ids=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_autoscale_policy.py b/plugins/modules/ibm_compute_autoscale_policy.py index 06fcfcc8f..0b2072a53 100644 --- a/plugins/modules/ibm_compute_autoscale_policy.py +++ b/plugins/modules/ibm_compute_autoscale_policy.py @@ -22,16 +22,6 @@ - Terraform v0.12.20 options: - name: - description: - - (Required for new resource) Name - required: True - type: str - scale_type: - description: - - (Required for new resource) scale type - required: True - type: str scale_amount: description: - (Required for new resource) Scale amount @@ -59,6 +49,16 @@ required: False type: list elements: str + name: + description: + - (Required for new resource) Name + required: True + type: str + scale_type: + description: + - (Required for new resource) scale type + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -105,21 +105,21 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), - ('scale_type', 'str'), ('scale_amount', 'int'), ('scale_group_id', 'int'), + ('name', 'str'), + ('scale_type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', - 'scale_type', 'scale_amount', 'cooldown', 'scale_group_id', 'triggers', 'tags', + 'name', + 'scale_type', ] # Params for Data source @@ -136,12 +136,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=False, - type='str'), - scale_type=dict( - required=False, - type='str'), scale_amount=dict( required=False, type='int'), @@ -159,6 +153,12 @@ required=False, elements='', type='list'), + name=dict( + required=False, + type='str'), + scale_type=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_bare_metal.py b/plugins/modules/ibm_compute_bare_metal.py index a577e5cf1..79056702d 100644 --- a/plugins/modules/ibm_compute_bare_metal.py +++ b/plugins/modules/ibm_compute_bare_metal.py @@ -22,154 +22,127 @@ - Terraform v0.12.20 options: - os_reference_code: - description: - - OS refernece code value - required: False - type: str - tcp_monitoring: - description: - - TCP monitoring enabled if set as true - required: False - type: bool - default: False - package_key_name: + gpu_secondary_key_name: description: - None required: False type: str - redundant_network: + unbonded_network: description: - None required: False type: bool default: False - memory: + restricted_network: description: - None required: False - type: int - hostname: - description: - - Host name - required: False - type: str + type: bool + default: False block_storage_ids: description: - None required: False type: list elements: int - fixed_config_preset: + image_template_id: description: - - Fixed config preset value + - OS image template ID required: False - type: str - ipv6_enabled: + type: int + network_speed: description: - - Boolean value true if IPV6 ia enabled or false + - Network speed in MBPS required: False - type: bool - default: False - gpu_secondary_key_name: + type: int + default: 100 + tcp_monitoring: description: - - None + - TCP monitoring enabled if set as true required: False - type: str + type: bool + default: False extended_hardware_testing: description: - None required: False type: bool default: False - public_bandwidth: - description: - - None - required: False - type: int - gpu_key_name: + private_subnet: description: - None required: False type: str - restricted_network: - description: - - None - required: False - type: bool - default: False domain: description: - (Required for new resource) Domain name required: True type: str - user_metadata: + ssh_key_ids: description: - - User metadata info + - SSH KEY IDS list required: False - type: str - software_guard_extensions: + type: list + elements: int + tags: description: - None required: False - type: bool - default: False + type: list + elements: str + private_vlan_id: + description: + - None + required: False + type: int ipv6_static_enabled: description: - boolean value true if ipv6 static is enabled else false required: False type: bool default: False - public_vlan_id: + hourly_billing: description: - - None + - Enables hourly billing required: False - type: int - private_subnet: + type: bool + default: True + package_key_name: description: - None required: False type: str - notes: + os_key_name: description: - - Optional notes info + - None required: False type: str - tags: + public_bandwidth: description: - None required: False - type: list - elements: str - unbonded_network: + type: int + storage_groups: description: - None required: False - type: bool - default: False - private_vlan_id: + type: list + elements: dict + public_subnet: description: - None required: False - type: int - hourly_billing: - description: - - Enables hourly billing - required: False - type: bool - default: True - private_network_only: + type: str + hostname: description: - - only private network configured if is true + - Host name required: False - type: bool - default: False - storage_groups: + type: str + fixed_config_preset: description: - - None + - Fixed config preset value required: False - type: list - elements: dict + type: str redundant_power_supply: description: - None @@ -181,45 +154,46 @@ required: False type: list elements: str - secondary_ip_count: + quote_id: description: - - Secondary IP addresses count + - Quote ID for Quote based provisioning required: False type: int - ssh_key_ids: + public_vlan_id: description: - - SSH KEY IDS list + - None required: False - type: list - elements: int - image_template_id: + type: int + ipv6_enabled: description: - - OS image template ID + - Boolean value true if IPV6 ia enabled or false required: False - type: int - datacenter: + type: bool + default: False + notes: description: - - None + - Optional notes info required: False type: str - process_key_name: + post_install_script_uri: description: - None required: False type: str - os_key_name: + os_reference_code: description: - - None + - OS refernece code value required: False type: str - quote_id: + private_network_only: description: - - Quote ID for Quote based provisioning + - only private network configured if is true required: False - type: int - public_subnet: + type: bool + default: False + user_metadata: description: - - None + - User metadata info required: False type: str file_storage_ids: @@ -228,17 +202,43 @@ required: False type: list elements: int - post_install_script_uri: + datacenter: description: - None required: False type: str - network_speed: + redundant_network: description: - - Network speed in MBPS + - None + required: False + type: bool + default: False + memory: + description: + - None required: False type: int - default: 100 + secondary_ip_count: + description: + - Secondary IP addresses count + required: False + type: int + software_guard_extensions: + description: + - None + required: False + type: bool + default: False + process_key_name: + description: + - None + required: False + type: str + gpu_key_name: + description: + - None + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -290,46 +290,46 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'os_reference_code', - 'tcp_monitoring', - 'package_key_name', - 'redundant_network', - 'memory', - 'hostname', - 'block_storage_ids', - 'fixed_config_preset', - 'ipv6_enabled', 'gpu_secondary_key_name', - 'extended_hardware_testing', - 'public_bandwidth', - 'gpu_key_name', + 'unbonded_network', 'restricted_network', - 'domain', - 'user_metadata', - 'software_guard_extensions', - 'ipv6_static_enabled', - 'public_vlan_id', + 'block_storage_ids', + 'image_template_id', + 'network_speed', + 'tcp_monitoring', + 'extended_hardware_testing', 'private_subnet', - 'notes', + 'domain', + 'ssh_key_ids', 'tags', - 'unbonded_network', 'private_vlan_id', + 'ipv6_static_enabled', 'hourly_billing', - 'private_network_only', + 'package_key_name', + 'os_key_name', + 'public_bandwidth', 'storage_groups', + 'public_subnet', + 'hostname', + 'fixed_config_preset', 'redundant_power_supply', 'disk_key_names', - 'secondary_ip_count', - 'ssh_key_ids', - 'image_template_id', - 'datacenter', - 'process_key_name', - 'os_key_name', 'quote_id', - 'public_subnet', - 'file_storage_ids', + 'public_vlan_id', + 'ipv6_enabled', + 'notes', 'post_install_script_uri', - 'network_speed', + 'os_reference_code', + 'private_network_only', + 'user_metadata', + 'file_storage_ids', + 'datacenter', + 'redundant_network', + 'memory', + 'secondary_ip_count', + 'software_guard_extensions', + 'process_key_name', + 'gpu_key_name', ] # Params for Data source @@ -337,105 +337,91 @@ ] TL_ALL_PARAMETERS_DS = [ + 'most_recent', 'domain', - 'global_identifier', 'hostname', - 'most_recent', + 'global_identifier', ] TL_CONFLICTS_MAP = { - 'os_reference_code': ['image_template_id'], 'image_template_id': ['os_reference_code'], + 'os_reference_code': ['image_template_id'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - os_reference_code=dict( + gpu_secondary_key_name=dict( required=False, type='str'), - tcp_monitoring=dict( + unbonded_network=dict( required=False, type='bool'), - package_key_name=dict( - required=False, - type='str'), - redundant_network=dict( + restricted_network=dict( required=False, type='bool'), - memory=dict( - required=False, - type='int'), - hostname=dict( - required=False, - type='str'), block_storage_ids=dict( required=False, elements='', type='list'), - fixed_config_preset=dict( - required=False, - type='str'), - ipv6_enabled=dict( - required=False, - type='bool'), - gpu_secondary_key_name=dict( - required=False, - type='str'), - extended_hardware_testing=dict( - required=False, - type='bool'), - public_bandwidth=dict( + image_template_id=dict( required=False, type='int'), - gpu_key_name=dict( - required=False, - type='str'), - restricted_network=dict( - required=False, - type='bool'), - domain=dict( - required=False, - type='str'), - user_metadata=dict( + network_speed=dict( required=False, - type='str'), - software_guard_extensions=dict( + type='int'), + tcp_monitoring=dict( required=False, type='bool'), - ipv6_static_enabled=dict( + extended_hardware_testing=dict( required=False, type='bool'), - public_vlan_id=dict( - required=False, - type='int'), private_subnet=dict( required=False, type='str'), - notes=dict( + domain=dict( required=False, type='str'), - tags=dict( + ssh_key_ids=dict( required=False, elements='', type='list'), - unbonded_network=dict( + tags=dict( required=False, - type='bool'), + elements='', + type='list'), private_vlan_id=dict( required=False, type='int'), - hourly_billing=dict( + ipv6_static_enabled=dict( required=False, type='bool'), - private_network_only=dict( + hourly_billing=dict( required=False, type='bool'), + package_key_name=dict( + required=False, + type='str'), + os_key_name=dict( + required=False, + type='str'), + public_bandwidth=dict( + required=False, + type='int'), storage_groups=dict( required=False, elements='', type='list'), + public_subnet=dict( + required=False, + type='str'), + hostname=dict( + required=False, + type='str'), + fixed_config_preset=dict( + required=False, + type='str'), redundant_power_supply=dict( required=False, type='bool'), @@ -443,41 +429,55 @@ required=False, elements='', type='list'), - secondary_ip_count=dict( + quote_id=dict( required=False, type='int'), - ssh_key_ids=dict( - required=False, - elements='', - type='list'), - image_template_id=dict( + public_vlan_id=dict( required=False, type='int'), - datacenter=dict( + ipv6_enabled=dict( + required=False, + type='bool'), + notes=dict( required=False, type='str'), - process_key_name=dict( + post_install_script_uri=dict( required=False, type='str'), - os_key_name=dict( + os_reference_code=dict( required=False, type='str'), - quote_id=dict( + private_network_only=dict( required=False, - type='int'), - public_subnet=dict( + type='bool'), + user_metadata=dict( required=False, type='str'), file_storage_ids=dict( required=False, elements='', type='list'), - post_install_script_uri=dict( + datacenter=dict( required=False, type='str'), - network_speed=dict( + redundant_network=dict( + required=False, + type='bool'), + memory=dict( required=False, type='int'), + secondary_ip_count=dict( + required=False, + type='int'), + software_guard_extensions=dict( + required=False, + type='bool'), + process_key_name=dict( + required=False, + type='str'), + gpu_key_name=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_bare_metal_info.py b/plugins/modules/ibm_compute_bare_metal_info.py index 05110378d..08c72acbf 100644 --- a/plugins/modules/ibm_compute_bare_metal_info.py +++ b/plugins/modules/ibm_compute_bare_metal_info.py @@ -21,14 +21,15 @@ - Terraform v0.12.20 options: - domain: + most_recent: description: - - The domain of the bare metal server + - If true and multiple entries are found, the most recently created bare metal is used. If false, an error is returned required: False - type: str - global_identifier: + type: bool + default: False + domain: description: - - The unique global identifier of the bare metal server + - The domain of the bare metal server required: False type: str hostname: @@ -36,12 +37,11 @@ - The hostname of the bare metal server required: False type: str - most_recent: + global_identifier: description: - - If true and multiple entries are found, the most recently created bare metal is used. If false, an error is returned + - The unique global identifier of the bare metal server required: False - type: bool - default: False + type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -79,36 +79,36 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'most_recent', 'domain', - 'global_identifier', 'hostname', - 'most_recent', + 'global_identifier', ] TL_CONFLICTS_MAP = { + 'most_recent': ['global_identifier'], 'domain': ['global_identifier'], - 'global_identifier': ['hostname', 'domain', 'most_recent'], 'hostname': ['global_identifier'], - 'most_recent': ['global_identifier'], + 'global_identifier': ['hostname', 'domain', 'most_recent'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - domain=dict( + most_recent=dict( required=False, - type='str'), - global_identifier=dict( + type='bool'), + domain=dict( required=False, type='str'), hostname=dict( required=False, type='str'), - most_recent=dict( + global_identifier=dict( required=False, - type='bool'), + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_compute_dedicated_host.py b/plugins/modules/ibm_compute_dedicated_host.py index 2baab4786..1e12f4b29 100644 --- a/plugins/modules/ibm_compute_dedicated_host.py +++ b/plugins/modules/ibm_compute_dedicated_host.py @@ -22,11 +22,18 @@ - Terraform v0.12.20 options: - domain: + wait_time_minutes: description: - - (Required for new resource) The domain of dedicatated host. - required: True - type: str + - None + required: False + type: int + default: 90 + tags: + description: + - None + required: False + type: list + elements: str datacenter: description: - (Required for new resource) The data center in which the dedicatated host is to be provisioned. @@ -37,35 +44,28 @@ - (Required for new resource) The hostname of the primary router that the dedicated host is associated with. required: True type: str + hourly_billing: + description: + - The billing type for the dedicatated host. + required: False + type: bool + default: True hostname: description: - (Required for new resource) The host name of dedicatated host. required: True type: str + domain: + description: + - (Required for new resource) The domain of dedicatated host. + required: True + type: str flavor: description: - The flavor of the dedicatated host. required: False type: str default: 56_CORES_X_242_RAM_X_1_4_TB - hourly_billing: - description: - - The billing type for the dedicatated host. - required: False - type: bool - default: True - wait_time_minutes: - description: - - None - required: False - type: int - default: 90 - tags: - description: - - None - required: False - type: list - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -112,22 +112,22 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('domain', 'str'), ('datacenter', 'str'), ('router_hostname', 'str'), ('hostname', 'str'), + ('domain', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'domain', + 'wait_time_minutes', + 'tags', 'datacenter', 'router_hostname', + 'hourly_billing', 'hostname', + 'domain', 'flavor', - 'hourly_billing', - 'wait_time_minutes', - 'tags', ] # Params for Data source @@ -144,31 +144,31 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - domain=dict( + wait_time_minutes=dict( required=False, - type='str'), + type='int'), + tags=dict( + required=False, + elements='', + type='list'), datacenter=dict( required=False, type='str'), router_hostname=dict( required=False, type='str'), + hourly_billing=dict( + required=False, + type='bool'), hostname=dict( required=False, type='str'), - flavor=dict( + domain=dict( required=False, type='str'), - hourly_billing=dict( - required=False, - type='bool'), - wait_time_minutes=dict( - required=False, - type='int'), - tags=dict( + flavor=dict( required=False, - elements='', - type='list'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_monitor.py b/plugins/modules/ibm_compute_monitor.py index 74e63b03d..d5665405e 100644 --- a/plugins/modules/ibm_compute_monitor.py +++ b/plugins/modules/ibm_compute_monitor.py @@ -22,6 +22,21 @@ - Terraform v0.12.20 options: + guest_id: + description: + - (Required for new resource) Guest ID + required: True + type: int + ip_address: + description: + - IP Address + required: False + type: str + query_type_id: + description: + - (Required for new resource) Query Type ID + required: True + type: int response_action_id: description: - (Required for new resource) Response action ID @@ -44,21 +59,6 @@ required: False type: list elements: str - guest_id: - description: - - (Required for new resource) Guest ID - required: True - type: int - ip_address: - description: - - IP Address - required: False - type: str - query_type_id: - description: - - (Required for new resource) Query Type ID - required: True - type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -105,20 +105,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('response_action_id', 'int'), ('guest_id', 'int'), ('query_type_id', 'int'), + ('response_action_id', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'guest_id', + 'ip_address', + 'query_type_id', 'response_action_id', 'wait_cycles', 'notified_users', 'tags', - 'guest_id', - 'ip_address', - 'query_type_id', ] # Params for Data source @@ -135,6 +135,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + guest_id=dict( + required=False, + type='int'), + ip_address=dict( + required=False, + type='str'), + query_type_id=dict( + required=False, + type='int'), response_action_id=dict( required=False, type='int'), @@ -149,15 +158,6 @@ required=False, elements='', type='list'), - guest_id=dict( - required=False, - type='int'), - ip_address=dict( - required=False, - type='str'), - query_type_id=dict( - required=False, - type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_placement_group.py b/plugins/modules/ibm_compute_placement_group.py index c682ec02c..33e29b65c 100644 --- a/plugins/modules/ibm_compute_placement_group.py +++ b/plugins/modules/ibm_compute_placement_group.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + datacenter: + description: + - (Required for new resource) Dataceneter name + required: True + type: str pod: description: - (Required for new resource) Pod name @@ -44,11 +49,6 @@ required: False type: list elements: str - datacenter: - description: - - (Required for new resource) Dataceneter name - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -95,18 +95,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('datacenter', 'str'), ('pod', 'str'), ('name', 'str'), - ('datacenter', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'datacenter', 'pod', 'name', 'rule', 'tags', - 'datacenter', ] # Params for Data source @@ -125,6 +125,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + datacenter=dict( + required=False, + type='str'), pod=dict( required=False, type='str'), @@ -138,9 +141,6 @@ required=False, elements='', type='list'), - datacenter=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_provisioning_hook.py b/plugins/modules/ibm_compute_provisioning_hook.py index ea4430253..a0f96bd69 100644 --- a/plugins/modules/ibm_compute_provisioning_hook.py +++ b/plugins/modules/ibm_compute_provisioning_hook.py @@ -22,6 +22,12 @@ - Terraform v0.12.20 options: + tags: + description: + - Tags associated with resource + required: False + type: list + elements: str name: description: - (Required for new resource) Provision hook name @@ -32,12 +38,6 @@ - (Required for new resource) URI of the hook required: True type: str - tags: - description: - - Tags associated with resource - required: False - type: list - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -90,9 +90,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'tags', 'name', 'uri', - 'tags', ] # Params for Data source @@ -109,16 +109,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + tags=dict( + required=False, + elements='', + type='list'), name=dict( required=False, type='str'), uri=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_reserved_capacity.py b/plugins/modules/ibm_compute_reserved_capacity.py index d6115a37a..a7198ac6c 100644 --- a/plugins/modules/ibm_compute_reserved_capacity.py +++ b/plugins/modules/ibm_compute_reserved_capacity.py @@ -22,6 +22,17 @@ - Terraform v0.12.20 options: + tags: + description: + - List of tags + required: False + type: list + elements: str + force_create: + description: + - Force the creation of reserved capacity with same name + required: False + type: bool datacenter: description: - (Required for new resource) Dataceneter name @@ -47,17 +58,6 @@ - (Required for new resource) flavor of the reserved capacity required: True type: str - tags: - description: - - List of tags - required: False - type: list - elements: str - force_create: - description: - - Force the creation of reserved capacity with same name - required: False - type: bool id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -113,13 +113,13 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'tags', + 'force_create', 'datacenter', 'pod', 'name', 'instances', 'flavor', - 'tags', - 'force_create', ] # Params for Data source @@ -139,6 +139,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + tags=dict( + required=False, + elements='', + type='list'), + force_create=dict( + required=False, + type='bool'), datacenter=dict( required=False, type='str'), @@ -154,13 +161,6 @@ flavor=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), - force_create=dict( - required=False, - type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_ssh_key.py b/plugins/modules/ibm_compute_ssh_key.py index fd361c16b..fd7b12589 100644 --- a/plugins/modules/ibm_compute_ssh_key.py +++ b/plugins/modules/ibm_compute_ssh_key.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - label: - description: - - (Required for new resource) SSH Key label - required: True - type: str public_key: description: - (Required for new resource) Plublic Key info @@ -43,6 +38,11 @@ required: False type: list elements: str + label: + description: + - (Required for new resource) SSH Key label + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -89,16 +89,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('label', 'str'), ('public_key', 'str'), + ('label', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'label', 'public_key', 'notes', 'tags', + 'label', ] # Params for Data source @@ -107,8 +107,8 @@ ] TL_ALL_PARAMETERS_DS = [ - 'most_recent', 'label', + 'most_recent', ] TL_CONFLICTS_MAP = { @@ -118,9 +118,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - label=dict( - required=False, - type='str'), public_key=dict( required=False, type='str'), @@ -131,6 +128,9 @@ required=False, elements='', type='list'), + label=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_ssh_key_info.py b/plugins/modules/ibm_compute_ssh_key_info.py index c50bfeb99..29b4c665f 100644 --- a/plugins/modules/ibm_compute_ssh_key_info.py +++ b/plugins/modules/ibm_compute_ssh_key_info.py @@ -21,17 +21,17 @@ - Terraform v0.12.20 options: + label: + description: + - The label associated with the ssh key + required: True + type: str most_recent: description: - If true and multiple entries are found, the most recently created key is used. If false, an error is returned required: False type: bool default: False - label: - description: - - The label associated with the ssh key - required: True - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -70,8 +70,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'most_recent', 'label', + 'most_recent', ] @@ -82,12 +82,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - most_recent=dict( - required=False, - type='bool'), label=dict( required=True, type='str'), + most_recent=dict( + required=False, + type='bool'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_compute_ssl_certificate.py b/plugins/modules/ibm_compute_ssl_certificate.py index 93c389c5e..631ec4f96 100644 --- a/plugins/modules/ibm_compute_ssl_certificate.py +++ b/plugins/modules/ibm_compute_ssl_certificate.py @@ -22,27 +22,27 @@ - Terraform v0.12.20 options: - certificate: - description: - - (Required for new resource) SSL Certifcate - required: True - type: str intermediate_certificate: description: - Intermediate certificate value required: False type: str - private_key: - description: - - (Required for new resource) SSL Private Key - required: True - type: str tags: description: - Tags set for resource required: False type: list elements: str + certificate: + description: + - (Required for new resource) SSL Certifcate + required: True + type: str + private_key: + description: + - (Required for new resource) SSL Private Key + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -95,10 +95,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'certificate', 'intermediate_certificate', - 'private_key', 'tags', + 'certificate', + 'private_key', ] # Params for Data source @@ -115,19 +115,19 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - certificate=dict( - required=False, - type='str'), intermediate_certificate=dict( required=False, type='str'), - private_key=dict( - required=False, - type='str'), tags=dict( required=False, elements='', type='list'), + certificate=dict( + required=False, + type='str'), + private_key=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_user.py b/plugins/modules/ibm_compute_user.py index 552bf736c..cc9639f17 100644 --- a/plugins/modules/ibm_compute_user.py +++ b/plugins/modules/ibm_compute_user.py @@ -22,55 +22,51 @@ - Terraform v0.12.20 options: - email: + user_status: description: - - (Required for new resource) email address of the user - required: True + - user status info + required: False type: str - country: + default: ACTIVE + company_name: description: - - (Required for new resource) Country name + - (Required for new resource) comapany name required: True type: str - timezone: + address1: description: - - (Required for new resource) time zone info + - (Required for new resource) Address info of the user required: True type: str - first_name: + state_: description: - - (Required for new resource) First name of the user + - (Required for new resource) Satate name required: True type: str - address1: + country: description: - - (Required for new resource) Address info of the user + - (Required for new resource) Country name required: True type: str - address2: - description: - - Address info of the user - required: False - type: str password: description: - password for the user required: False type: str - api_key: + last_name: description: - - API key for the user - required: False + - (Required for new resource) Last name of the user + required: True type: str - username: + email: description: - - user name - required: False + - (Required for new resource) email address of the user + required: True type: str - last_name: + address2: description: - - (Required for new resource) Last name of the user - required: True + - Address info of the user + required: False type: str permissions: description: @@ -78,39 +74,43 @@ required: False type: list elements: str + api_key: + description: + - API key for the user + required: False + type: str tags: description: - Tags set for the resources required: False type: list elements: str - company_name: - description: - - (Required for new resource) comapany name - required: True - type: str - city: + username: description: - - (Required for new resource) City name - required: True + - user name + required: False type: str - state_: + first_name: description: - - (Required for new resource) Satate name + - (Required for new resource) First name of the user required: True type: str - user_status: - description: - - user status info - required: False - type: str - default: ACTIVE has_api_key: description: - API Key info of the user required: False type: bool default: False + city: + description: + - (Required for new resource) City name + required: True + type: str + timezone: + description: + - (Required for new resource) time zone info + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -157,36 +157,36 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('email', 'str'), - ('country', 'str'), - ('timezone', 'str'), - ('first_name', 'str'), + ('company_name', 'str'), ('address1', 'str'), + ('state_', 'str'), + ('country', 'str'), ('last_name', 'str'), - ('company_name', 'str'), + ('email', 'str'), + ('first_name', 'str'), ('city', 'str'), - ('state_', 'str'), + ('timezone', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'email', - 'country', - 'timezone', - 'first_name', + 'user_status', + 'company_name', 'address1', - 'address2', + 'state_', + 'country', 'password', - 'api_key', - 'username', 'last_name', + 'email', + 'address2', 'permissions', + 'api_key', 'tags', - 'company_name', - 'city', - 'state_', - 'user_status', + 'username', + 'first_name', 'has_api_key', + 'city', + 'timezone', ] # Params for Data source @@ -203,59 +203,59 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - email=dict( - required=False, - type='str'), - country=dict( + user_status=dict( required=False, type='str'), - timezone=dict( + company_name=dict( required=False, type='str'), - first_name=dict( + address1=dict( required=False, type='str'), - address1=dict( + state_=dict( required=False, type='str'), - address2=dict( + country=dict( required=False, type='str'), password=dict( required=False, type='str'), - api_key=dict( + last_name=dict( required=False, type='str'), - username=dict( + email=dict( required=False, type='str'), - last_name=dict( + address2=dict( required=False, type='str'), permissions=dict( required=False, elements='', type='list'), + api_key=dict( + required=False, + type='str'), tags=dict( required=False, elements='', type='list'), - company_name=dict( + username=dict( required=False, type='str'), - city=dict( + first_name=dict( required=False, type='str'), - state_=dict( + has_api_key=dict( required=False, - type='str'), - user_status=dict( + type='bool'), + city=dict( required=False, type='str'), - has_api_key=dict( + timezone=dict( required=False, - type='bool'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_vm_instance.py b/plugins/modules/ibm_compute_vm_instance.py index eb3f8c1c0..667195586 100644 --- a/plugins/modules/ibm_compute_vm_instance.py +++ b/plugins/modules/ibm_compute_vm_instance.py @@ -22,128 +22,113 @@ - Terraform v0.12.20 options: - tags: + public_bandwidth_limited: description: - None required: False - type: list - elements: str - ipv6_static_enabled: + type: int + domain: description: - None required: False - type: bool - default: False - placement_group_id: + type: str + memory: description: - - The placement group id + - None required: False type: int - cores: + network_speed: description: - None required: False type: int - disks: + default: 100 + block_storage_ids: description: - None required: False type: list elements: int - datacenter: + user_metadata: description: - None required: False type: str - datacenter_choice: - description: - - The user provided datacenter options - required: False - type: list - elements: dict - public_security_group_ids: + dedicated_acct_host_only: description: - None required: False - type: list - elements: int - private_security_group_ids: + type: bool + transient: description: - None required: False - type: list - elements: int - network_speed: + type: bool + image_id: description: - None required: False type: int - default: 100 - ipv6_enabled: + hourly_billing: description: - None required: False type: bool - default: False - dedicated_host_id: - description: - - None - required: False - type: int - dedicated_host_name: + default: True + placement_group_name: description: - - None + - The placement group name required: False type: str - public_bandwidth_unlimited: + private_vlan_id: description: - None required: False - type: bool - default: False - evault: + type: int + tags: description: - None required: False - type: int - reserved_instance_primary_disk: + type: list + elements: str + quote_id: description: - - The primary disk of reserved instance + - Quote ID for Quote based provisioning required: False type: int - memory: + public_vlan_id: description: - None required: False type: int - placement_group_name: + private_subnet: description: - - The placement group name + - None required: False type: str - hostname: + evault: description: - None required: False - type: str - bulk_vms: + type: int + ssh_key_ids: description: - None required: False type: list - elements: dict - private_network_only: + elements: int + public_security_group_ids: description: - None required: False - type: bool - default: False - public_bandwidth_limited: + type: list + elements: int + reserved_capacity_name: description: - - None + - The reserved group id required: False - type: int - os_reference_code: + type: str + dedicated_host_name: description: - None required: False @@ -154,110 +139,125 @@ required: False type: list elements: int - post_install_script_uri: + datacenter: description: - None required: False type: str - ssh_key_ids: + public_subnet: description: - None required: False - type: list - elements: int - secondary_ip_count: + type: str + ipv6_static_enabled: description: - None required: False - type: int - public_vlan_id: + type: bool + default: False + post_install_script_uri: description: - None required: False - type: int - private_subnet: + type: str + private_network_only: description: - None required: False - type: str - image_id: + type: bool + default: False + placement_group_id: description: - - None + - The placement group id required: False type: int - reserved_capacity_name: + notes: description: - - The reserved group id + - None required: False type: str - flavor_key_name: + local_disk: description: - - Flavor key name used to provision vm. + - None required: False - type: str - notes: + type: bool + default: True + bulk_vms: description: - None required: False - type: str - private_vlan_id: + type: list + elements: dict + reserved_capacity_id: description: - - None + - The reserved group id required: False type: int - block_storage_ids: + flavor_key_name: + description: + - Flavor key name used to provision vm. + required: False + type: str + disks: description: - None required: False type: list elements: int - public_subnet: + ipv6_enabled: description: - None required: False - type: str - user_metadata: + type: bool + default: False + hostname: description: - None required: False type: str - domain: + os_reference_code: description: - None required: False type: str - dedicated_acct_host_only: + reserved_instance_primary_disk: description: - - None + - The primary disk of reserved instance required: False - type: bool - quote_id: + type: int + dedicated_host_id: description: - - Quote ID for Quote based provisioning + - None required: False type: int - transient: + secondary_ip_count: description: - None required: False - type: bool - hourly_billing: + type: int + public_bandwidth_unlimited: description: - None required: False type: bool - default: True - reserved_capacity_id: + default: False + cores: description: - - The reserved group id + - None required: False type: int - local_disk: + private_security_group_ids: description: - None required: False - type: bool - default: True + type: list + elements: int + datacenter_choice: + description: + - The user provided datacenter options + required: False + type: list + elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -308,50 +308,50 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'public_bandwidth_limited', + 'domain', + 'memory', + 'network_speed', + 'block_storage_ids', + 'user_metadata', + 'dedicated_acct_host_only', + 'transient', + 'image_id', + 'hourly_billing', + 'placement_group_name', + 'private_vlan_id', 'tags', + 'quote_id', + 'public_vlan_id', + 'private_subnet', + 'evault', + 'ssh_key_ids', + 'public_security_group_ids', + 'reserved_capacity_name', + 'dedicated_host_name', + 'file_storage_ids', + 'datacenter', + 'public_subnet', 'ipv6_static_enabled', + 'post_install_script_uri', + 'private_network_only', 'placement_group_id', - 'cores', + 'notes', + 'local_disk', + 'bulk_vms', + 'reserved_capacity_id', + 'flavor_key_name', 'disks', - 'datacenter', - 'datacenter_choice', - 'public_security_group_ids', - 'private_security_group_ids', - 'network_speed', 'ipv6_enabled', - 'dedicated_host_id', - 'dedicated_host_name', - 'public_bandwidth_unlimited', - 'evault', - 'reserved_instance_primary_disk', - 'memory', - 'placement_group_name', 'hostname', - 'bulk_vms', - 'private_network_only', - 'public_bandwidth_limited', 'os_reference_code', - 'file_storage_ids', - 'post_install_script_uri', - 'ssh_key_ids', + 'reserved_instance_primary_disk', + 'dedicated_host_id', 'secondary_ip_count', - 'public_vlan_id', - 'private_subnet', - 'image_id', - 'reserved_capacity_name', - 'flavor_key_name', - 'notes', - 'private_vlan_id', - 'block_storage_ids', - 'public_subnet', - 'user_metadata', - 'domain', - 'dedicated_acct_host_only', - 'quote_id', - 'transient', - 'hourly_billing', - 'reserved_capacity_id', - 'local_disk', + 'public_bandwidth_unlimited', + 'cores', + 'private_security_group_ids', + 'datacenter_choice', ] # Params for Data source @@ -362,180 +362,180 @@ TL_ALL_PARAMETERS_DS = [ 'domain', - 'most_recent', 'hostname', + 'most_recent', ] TL_CONFLICTS_MAP = { - 'placement_group_id': ['datacenter_choice', 'dedicated_acct_host_only', 'dedicated_host_name', 'dedicated_host_id', 'placement_group_name', 'reserved_capacity_id', 'reserved_capacity_name'], - 'cores': ['flavor_key_name'], - 'datacenter': ['datacenter_choice'], - 'datacenter_choice': ['datacenter', 'public_vlan_id', 'private_vlan_id', 'placement_group_name', 'placement_group_id', 'reserved_capacity_id', 'reserved_capacity_name'], - 'dedicated_host_id': ['dedicated_acct_host_only', 'dedicated_host_name', 'placement_group_name', 'placement_group_id'], - 'dedicated_host_name': ['dedicated_acct_host_only', 'dedicated_host_id', 'placement_group_name', 'placement_group_id'], - 'public_bandwidth_unlimited': ['private_network_only', 'public_bandwidth_limited'], - 'memory': ['flavor_key_name'], - 'placement_group_name': ['datacenter_choice', 'dedicated_acct_host_only', 'dedicated_host_name', 'dedicated_host_id', 'placement_group_id', 'reserved_capacity_id', 'reserved_capacity_name'], - 'hostname': ['bulk_vms'], - 'bulk_vms': ['hostname', 'domain'], 'public_bandwidth_limited': ['private_network_only', 'public_bandwidth_unlimited'], - 'os_reference_code': ['image_id'], - 'public_vlan_id': ['datacenter_choice'], - 'image_id': ['os_reference_code'], - 'reserved_capacity_name': ['datacenter_choice', 'dedicated_acct_host_only', 'dedicated_host_name', 'dedicated_host_id', 'placement_group_name', 'placement_group_id', 'reserved_capacity_id', 'flavor_key_name', 'cores', 'memory'], - 'flavor_key_name': ['cores', 'memory'], - 'private_vlan_id': ['datacenter_choice'], 'domain': ['bulk_vms'], + 'memory': ['flavor_key_name'], 'dedicated_acct_host_only': ['dedicated_host_name', 'dedicated_host_id', 'placement_group_id', 'placement_group_name'], 'transient': ['dedicated_acct_host_only', 'dedicated_host_name', 'dedicated_host_id', 'cores', 'memory', 'public_bandwidth_limited', 'public_bandwidth_unlimited'], + 'image_id': ['os_reference_code'], + 'placement_group_name': ['datacenter_choice', 'dedicated_acct_host_only', 'dedicated_host_name', 'dedicated_host_id', 'placement_group_id', 'reserved_capacity_id', 'reserved_capacity_name'], + 'private_vlan_id': ['datacenter_choice'], + 'public_vlan_id': ['datacenter_choice'], + 'reserved_capacity_name': ['datacenter_choice', 'dedicated_acct_host_only', 'dedicated_host_name', 'dedicated_host_id', 'placement_group_name', 'placement_group_id', 'reserved_capacity_id', 'flavor_key_name', 'cores', 'memory'], + 'dedicated_host_name': ['dedicated_acct_host_only', 'dedicated_host_id', 'placement_group_name', 'placement_group_id'], + 'datacenter': ['datacenter_choice'], + 'placement_group_id': ['datacenter_choice', 'dedicated_acct_host_only', 'dedicated_host_name', 'dedicated_host_id', 'placement_group_name', 'reserved_capacity_id', 'reserved_capacity_name'], + 'bulk_vms': ['hostname', 'domain'], 'reserved_capacity_id': ['datacenter_choice', 'dedicated_acct_host_only', 'dedicated_host_name', 'dedicated_host_id', 'placement_group_name', 'placement_group_id', 'reserved_capacity_name', 'flavor_key_name', 'cores', 'memory'], + 'flavor_key_name': ['cores', 'memory'], + 'hostname': ['bulk_vms'], + 'os_reference_code': ['image_id'], + 'dedicated_host_id': ['dedicated_acct_host_only', 'dedicated_host_name', 'placement_group_name', 'placement_group_id'], + 'public_bandwidth_unlimited': ['private_network_only', 'public_bandwidth_limited'], + 'cores': ['flavor_key_name'], + 'datacenter_choice': ['datacenter', 'public_vlan_id', 'private_vlan_id', 'placement_group_name', 'placement_group_id', 'reserved_capacity_id', 'reserved_capacity_name'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - tags=dict( + public_bandwidth_limited=dict( required=False, - elements='', - type='list'), - ipv6_static_enabled=dict( + type='int'), + domain=dict( required=False, - type='bool'), - placement_group_id=dict( + type='str'), + memory=dict( required=False, type='int'), - cores=dict( + network_speed=dict( required=False, type='int'), - disks=dict( + block_storage_ids=dict( required=False, elements='', type='list'), - datacenter=dict( + user_metadata=dict( required=False, type='str'), - datacenter_choice=dict( - required=False, - elements='', - type='list'), - public_security_group_ids=dict( + dedicated_acct_host_only=dict( required=False, - elements='', - type='list'), - private_security_group_ids=dict( + type='bool'), + transient=dict( required=False, - elements='', - type='list'), - network_speed=dict( + type='bool'), + image_id=dict( required=False, type='int'), - ipv6_enabled=dict( + hourly_billing=dict( required=False, type='bool'), - dedicated_host_id=dict( - required=False, - type='int'), - dedicated_host_name=dict( + placement_group_name=dict( required=False, type='str'), - public_bandwidth_unlimited=dict( - required=False, - type='bool'), - evault=dict( + private_vlan_id=dict( required=False, type='int'), - reserved_instance_primary_disk=dict( + tags=dict( + required=False, + elements='', + type='list'), + quote_id=dict( required=False, type='int'), - memory=dict( + public_vlan_id=dict( required=False, type='int'), - placement_group_name=dict( + private_subnet=dict( required=False, type='str'), - hostname=dict( + evault=dict( required=False, - type='str'), - bulk_vms=dict( + type='int'), + ssh_key_ids=dict( required=False, elements='', type='list'), - private_network_only=dict( + public_security_group_ids=dict( required=False, - type='bool'), - public_bandwidth_limited=dict( + elements='', + type='list'), + reserved_capacity_name=dict( required=False, - type='int'), - os_reference_code=dict( + type='str'), + dedicated_host_name=dict( required=False, type='str'), file_storage_ids=dict( required=False, elements='', type='list'), - post_install_script_uri=dict( + datacenter=dict( required=False, type='str'), - ssh_key_ids=dict( - required=False, - elements='', - type='list'), - secondary_ip_count=dict( + public_subnet=dict( required=False, - type='int'), - public_vlan_id=dict( + type='str'), + ipv6_static_enabled=dict( required=False, - type='int'), - private_subnet=dict( + type='bool'), + post_install_script_uri=dict( required=False, type='str'), - image_id=dict( + private_network_only=dict( + required=False, + type='bool'), + placement_group_id=dict( required=False, type='int'), - reserved_capacity_name=dict( + notes=dict( required=False, type='str'), - flavor_key_name=dict( + local_disk=dict( required=False, - type='str'), - notes=dict( + type='bool'), + bulk_vms=dict( required=False, - type='str'), - private_vlan_id=dict( + elements='', + type='list'), + reserved_capacity_id=dict( required=False, type='int'), - block_storage_ids=dict( + flavor_key_name=dict( + required=False, + type='str'), + disks=dict( required=False, elements='', type='list'), - public_subnet=dict( + ipv6_enabled=dict( required=False, - type='str'), - user_metadata=dict( + type='bool'), + hostname=dict( required=False, type='str'), - domain=dict( + os_reference_code=dict( required=False, type='str'), - dedicated_acct_host_only=dict( + reserved_instance_primary_disk=dict( required=False, - type='bool'), - quote_id=dict( + type='int'), + dedicated_host_id=dict( required=False, type='int'), - transient=dict( + secondary_ip_count=dict( required=False, - type='bool'), - hourly_billing=dict( + type='int'), + public_bandwidth_unlimited=dict( required=False, type='bool'), - reserved_capacity_id=dict( + cores=dict( required=False, type='int'), - local_disk=dict( + private_security_group_ids=dict( required=False, - type='bool'), + elements='', + type='list'), + datacenter_choice=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_compute_vm_instance_info.py b/plugins/modules/ibm_compute_vm_instance_info.py index 069a37918..5f150d248 100644 --- a/plugins/modules/ibm_compute_vm_instance_info.py +++ b/plugins/modules/ibm_compute_vm_instance_info.py @@ -26,17 +26,17 @@ - The domain of the virtual guest required: True type: str + hostname: + description: + - The hostname of the virtual guest + required: True + type: str most_recent: description: - If true and multiple entries are found, the most recently created virtual guest is used. If false, an error is returned required: False type: bool default: False - hostname: - description: - - The hostname of the virtual guest - required: True - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -77,8 +77,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'domain', - 'most_recent', 'hostname', + 'most_recent', ] @@ -92,12 +92,12 @@ domain=dict( required=True, type='str'), - most_recent=dict( - required=False, - type='bool'), hostname=dict( required=True, type='str'), + most_recent=dict( + required=False, + type='bool'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_container_addons.py b/plugins/modules/ibm_container_addons.py index 22a4bbb26..94d7eaeef 100644 --- a/plugins/modules/ibm_container_addons.py +++ b/plugins/modules/ibm_container_addons.py @@ -22,6 +22,12 @@ - Terraform v0.12.20 options: + addons: + description: + - (Required for new resource) + required: True + type: list + elements: dict cluster: description: - (Required for new resource) Cluster Name or ID @@ -32,12 +38,6 @@ - ID of the resource group. required: False type: str - addons: - description: - - (Required for new resource) - required: True - type: list - elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -64,15 +64,15 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('cluster', 'str'), ('addons', 'list'), + ('cluster', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'addons', 'cluster', 'resource_group_id', - 'addons', ] # Params for Data source @@ -91,16 +91,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + addons=dict( + required=False, + elements='', + type='list'), cluster=dict( required=False, type='str'), resource_group_id=dict( required=False, type='str'), - addons=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_alb.py b/plugins/modules/ibm_container_alb.py index 598c9a3dc..ad40aca90 100644 --- a/plugins/modules/ibm_container_alb.py +++ b/plugins/modules/ibm_container_alb.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - user_ip: - description: - - IP assigned by the user - required: False - type: str disable_deployment: description: - Set to true if ALB needs to be disabled @@ -37,6 +32,11 @@ - (Required for new resource) ALB ID required: True type: str + user_ip: + description: + - IP assigned by the user + required: False + type: str enable: description: - set to true if ALB needs to be enabled @@ -73,9 +73,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'user_ip', 'disable_deployment', 'alb_id', + 'user_ip', 'enable', ] @@ -97,15 +97,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - user_ip=dict( - required=False, - type='str'), disable_deployment=dict( required=False, type='bool'), alb_id=dict( required=False, type='str'), + user_ip=dict( + required=False, + type='str'), enable=dict( required=False, type='bool'), diff --git a/plugins/modules/ibm_container_alb_cert.py b/plugins/modules/ibm_container_alb_cert.py index 5ec1a32ca..2de62dd28 100644 --- a/plugins/modules/ibm_container_alb_cert.py +++ b/plugins/modules/ibm_container_alb_cert.py @@ -22,32 +22,32 @@ - Terraform v0.12.20 options: - secret_name: + cert_crn: description: - - (Required for new resource) Secret name + - (Required for new resource) Certificate CRN id required: True type: str - persistence: + namespace: description: - - Persistence of secret + - Namespace of the secret required: False - type: bool - cert_crn: - description: - - (Required for new resource) Certificate CRN id - required: True type: str + default: ibm-cert-store cluster_id: description: - (Required for new resource) Cluster ID required: True type: str - namespace: + secret_name: description: - - Namespace of the secret - required: False + - (Required for new resource) Secret name + required: True type: str - default: ibm-cert-store + persistence: + description: + - Persistence of secret + required: False + type: bool id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -74,18 +74,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('secret_name', 'str'), ('cert_crn', 'str'), ('cluster_id', 'str'), + ('secret_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'secret_name', - 'persistence', 'cert_crn', - 'cluster_id', 'namespace', + 'cluster_id', + 'secret_name', + 'persistence', ] # Params for Data source @@ -107,21 +107,21 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - secret_name=dict( + cert_crn=dict( required=False, type='str'), - persistence=dict( - required=False, - type='bool'), - cert_crn=dict( + namespace=dict( required=False, type='str'), cluster_id=dict( required=False, type='str'), - namespace=dict( + secret_name=dict( required=False, type='str'), + persistence=dict( + required=False, + type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_alb_create.py b/plugins/modules/ibm_container_alb_create.py index 2b5cf2b98..1f9924a3c 100644 --- a/plugins/modules/ibm_container_alb_create.py +++ b/plugins/modules/ibm_container_alb_create.py @@ -22,11 +22,12 @@ - Terraform v0.12.20 options: - zone: + enable: description: - - (Required for new resource) The zone where you want to deploy the ALB. - required: True - type: str + - If set to true, the ALB is enabled by default. + required: False + type: bool + default: True ip: description: - The IP address that you want to assign to the ALB. @@ -37,31 +38,30 @@ - The version of the network load balancer that you want to use for the ALB. required: False type: str - enable: + ingress_image: description: - - If set to true, the ALB is enabled by default. + - The type of Ingress image that you want to use for your ALB deployment. required: False - type: bool - default: True - cluster: - description: - - (Required for new resource) The ID of the cluster that the ALB belongs to. - required: True type: str vlan_id: description: - (Required for new resource) The VLAN ID that you want to use for your ALBs. required: True type: str + cluster: + description: + - (Required for new resource) The ID of the cluster that the ALB belongs to. + required: True + type: str alb_type: description: - (Required for new resource) The type of ALB that you want to create. required: True type: str - ingress_image: + zone: description: - - The type of Ingress image that you want to use for your ALB deployment. - required: False + - (Required for new resource) The zone where you want to deploy the ALB. + required: True type: str id: description: @@ -89,22 +89,22 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('zone', 'str'), - ('cluster', 'str'), ('vlan_id', 'str'), + ('cluster', 'str'), ('alb_type', 'str'), + ('zone', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'zone', + 'enable', 'ip', 'nlb_version', - 'enable', - 'cluster', + 'ingress_image', 'vlan_id', + 'cluster', 'alb_type', - 'ingress_image', + 'zone', ] # Params for Data source @@ -121,28 +121,28 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - zone=dict( + enable=dict( required=False, - type='str'), + type='bool'), ip=dict( required=False, type='str'), nlb_version=dict( required=False, type='str'), - enable=dict( - required=False, - type='bool'), - cluster=dict( + ingress_image=dict( required=False, type='str'), vlan_id=dict( required=False, type='str'), + cluster=dict( + required=False, + type='str'), alb_type=dict( required=False, type='str'), - ingress_image=dict( + zone=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_container_api_key_reset.py b/plugins/modules/ibm_container_api_key_reset.py index 4a8f42171..1034467de 100644 --- a/plugins/modules/ibm_container_api_key_reset.py +++ b/plugins/modules/ibm_container_api_key_reset.py @@ -22,6 +22,12 @@ - Terraform v0.12.20 options: + reset_api_key: + description: + - Determines if apikey has to be reset or not + required: False + type: int + default: 1 region: description: - (Required for new resource) Region which api key has to be reset @@ -32,12 +38,6 @@ - ID of Resource Group required: False type: str - reset_api_key: - description: - - Determines if apikey has to be reset or not - required: False - type: int - default: 1 id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -69,9 +69,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'reset_api_key', 'region', 'resource_group_id', - 'reset_api_key', ] # Params for Data source @@ -88,15 +88,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + reset_api_key=dict( + required=False, + type='int'), region=dict( required=False, type='str'), resource_group_id=dict( required=False, type='str'), - reset_api_key=dict( - required=False, - type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_bind_service.py b/plugins/modules/ibm_container_bind_service.py index 4096b3eb4..ba9cb0921 100644 --- a/plugins/modules/ibm_container_bind_service.py +++ b/plugins/modules/ibm_container_bind_service.py @@ -22,19 +22,24 @@ - Terraform v0.12.20 options: - service_instance_name: + role: description: - - serivice instance name + - Role info required: False type: str + cluster_name_id: + description: + - (Required for new resource) Cluster name or ID + required: True + type: str namespace_id: description: - (Required for new resource) namespace ID required: True type: str - role: + key: description: - - Role info + - Key info required: False type: str resource_group_id: @@ -48,21 +53,16 @@ required: False type: list elements: str - cluster_name_id: + service_instance_name: description: - - (Required for new resource) Cluster name or ID - required: True + - serivice instance name + required: False type: str service_instance_id: description: - Service instance ID required: False type: str - key: - description: - - Key info - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -89,20 +89,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('namespace_id', 'str'), ('cluster_name_id', 'str'), + ('namespace_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'service_instance_name', - 'namespace_id', 'role', + 'cluster_name_id', + 'namespace_id', + 'key', 'resource_group_id', 'tags', - 'cluster_name_id', + 'service_instance_name', 'service_instance_id', - 'key', ] # Params for Data source @@ -112,10 +112,10 @@ ] TL_ALL_PARAMETERS_DS = [ - 'service_instance_name', 'namespace_id', 'cluster_name_id', 'service_instance_id', + 'service_instance_name', ] TL_CONFLICTS_MAP = { @@ -127,13 +127,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - service_instance_name=dict( + role=dict( + required=False, + type='str'), + cluster_name_id=dict( required=False, type='str'), namespace_id=dict( required=False, type='str'), - role=dict( + key=dict( required=False, type='str'), resource_group_id=dict( @@ -143,15 +146,12 @@ required=False, elements='', type='list'), - cluster_name_id=dict( + service_instance_name=dict( required=False, type='str'), service_instance_id=dict( required=False, type='str'), - key=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_bind_service_info.py b/plugins/modules/ibm_container_bind_service_info.py index 6ec136cd0..cb6a62e07 100644 --- a/plugins/modules/ibm_container_bind_service_info.py +++ b/plugins/modules/ibm_container_bind_service_info.py @@ -21,11 +21,6 @@ - Terraform v0.12.20 options: - service_instance_name: - description: - - serivice instance name - required: False - type: str namespace_id: description: - namespace ID @@ -41,6 +36,11 @@ - Service instance ID required: False type: str + service_instance_name: + description: + - serivice instance name + required: False + type: str ibmcloud_api_key: description: - The IBM Cloud API key to authenticate with the IBM Cloud @@ -60,25 +60,22 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'service_instance_name', 'namespace_id', 'cluster_name_id', 'service_instance_id', + 'service_instance_name', ] TL_CONFLICTS_MAP = { - 'service_instance_name': ['service_instance_id'], 'service_instance_id': ['service_instance_name'], + 'service_instance_name': ['service_instance_id'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - service_instance_name=dict( - required=False, - type='str'), namespace_id=dict( required=True, type='str'), @@ -88,6 +85,9 @@ service_instance_id=dict( required=False, type='str'), + service_instance_name=dict( + required=False, + type='str'), ibmcloud_api_key=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_container_cluster.py b/plugins/modules/ibm_container_cluster.py index 10825deba..402371b7f 100644 --- a/plugins/modules/ibm_container_cluster.py +++ b/plugins/modules/ibm_container_cluster.py @@ -22,61 +22,47 @@ - Terraform v0.12.20 options: - datacenter: + kube_version: description: - - (Required for new resource) The datacenter where this cluster will be deployed - required: True + - Kubernetes version info + required: False type: str - default_pool_size: + service_subnet: description: - - The size of the default worker pool + - Custom subnet CIDR to provide private IP addresses for services required: False - type: int - default: 1 - taints: + type: str + no_subnet: description: - - WorkerPool Taints + - Boolean value set to true when subnet creation is not required. required: False - type: list - elements: dict + type: bool + default: False force_delete_storage: description: - Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered required: False type: bool default: False - tags: - description: - - Tags for the resource - required: False - type: list - elements: str - disk_encryption: + private_service_endpoint: description: - - disc encryption done, if set to true. + - None required: False type: bool - default: True - retry_patch_version: - description: - - Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails - required: False - type: int - update_all_workers: + datacenter: description: - - Updates all the woker nodes if sets to true - required: False - type: bool - default: False - wait_till: + - (Required for new resource) The datacenter where this cluster will be deployed + required: True + type: str + workers_info: description: - - wait_till can be configured for Master Ready, One worker Ready or Ingress Ready + - The IDs of the worker node required: False - type: str - default: IngressReady - machine_type: + type: list + elements: dict + resource_group_id: description: - - Machine type + - ID of the resource group. required: False type: str hardware: @@ -84,109 +70,123 @@ - (Required for new resource) Hardware type required: True type: str - private_vlan_id: - description: - - Private VLAN ID - required: False - type: str - labels: + subnet_id: description: - - list of labels to the default worker pool + - List of subnet IDs required: False - type: dict + type: list elements: str - resource_group_id: - description: - - ID of the resource group. - required: False - type: str webhook: description: - None required: False type: list elements: dict - gateway_enabled: + labels: description: - - Set true for gateway enabled clusters + - list of labels to the default worker pool + required: False + type: dict + elements: str + disk_encryption: + description: + - disc encryption done, if set to true. required: False type: bool - default: False - pod_subnet: + default: True + patch_version: description: - - Custom subnet CIDR to provide private IP addresses for pods + - Kubernetes patch version required: False type: str - no_subnet: + retry_patch_version: description: - - Boolean value set to true when subnet creation is not required. + - Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails required: False - type: bool - default: False + type: int + machine_type: + description: + - Machine type + required: False + type: str name: description: - (Required for new resource) The cluster name required: True type: str - kube_version: + kms_config: description: - - Kubernetes version info + - Enables KMS on a given cluster required: False - type: str - entitlement: + type: list + elements: dict + gateway_enabled: description: - - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + - Set true for gateway enabled clusters required: False - type: str - public_service_endpoint: + type: bool + default: False + public_vlan_id: description: - - None + - Public VLAN ID required: False - type: bool - patch_version: + type: str + pod_subnet: description: - - Kubernetes patch version + - Custom subnet CIDR to provide private IP addresses for pods required: False type: str - public_vlan_id: + private_vlan_id: description: - - Public VLAN ID + - Private VLAN ID required: False type: str - private_service_endpoint: + default_pool_size: description: - - None + - The size of the default worker pool + required: False + type: int + default: 1 + wait_for_worker_update: + description: + - Wait for worker node to update during kube version update. required: False type: bool - service_subnet: + default: True + wait_till: description: - - Custom subnet CIDR to provide private IP addresses for services + - wait_till can be configured for Master Ready, One worker Ready or Ingress Ready required: False type: str - subnet_id: + default: IngressReady + tags: description: - - List of subnet IDs + - Tags for the resource required: False type: list elements: str - kms_config: + public_service_endpoint: description: - - Enables KMS on a given cluster + - None required: False - type: list - elements: dict - workers_info: + type: bool + taints: description: - - The IDs of the worker node + - WorkerPool Taints required: False type: list elements: dict - wait_for_worker_update: + entitlement: description: - - Wait for worker node to update during kube version update. + - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + required: False + type: str + update_all_workers: + description: + - Updates all the woker nodes if sets to true required: False type: bool - default: True + default: False id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -220,36 +220,36 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'datacenter', - 'default_pool_size', - 'taints', + 'kube_version', + 'service_subnet', + 'no_subnet', 'force_delete_storage', - 'tags', + 'private_service_endpoint', + 'datacenter', + 'workers_info', + 'resource_group_id', + 'hardware', + 'subnet_id', + 'webhook', + 'labels', 'disk_encryption', + 'patch_version', 'retry_patch_version', - 'update_all_workers', - 'wait_till', 'machine_type', - 'hardware', - 'private_vlan_id', - 'labels', - 'resource_group_id', - 'webhook', - 'gateway_enabled', - 'pod_subnet', - 'no_subnet', 'name', - 'kube_version', - 'entitlement', - 'public_service_endpoint', - 'patch_version', - 'public_vlan_id', - 'private_service_endpoint', - 'service_subnet', - 'subnet_id', 'kms_config', - 'workers_info', + 'gateway_enabled', + 'public_vlan_id', + 'pod_subnet', + 'private_vlan_id', + 'default_pool_size', 'wait_for_worker_update', + 'wait_till', + 'tags', + 'public_service_endpoint', + 'taints', + 'entitlement', + 'update_all_workers', ] # Params for Data source @@ -257,15 +257,15 @@ ] TL_ALL_PARAMETERS_DS = [ + 'org_guid', 'region', - 'resource_group_id', - 'name', 'list_bounded_services', - 'org_guid', 'account_guid', - 'cluster_name_id', - 'space_guid', + 'name', 'alb_type', + 'resource_group_id', + 'space_guid', + 'cluster_name_id', ] TL_CONFLICTS_MAP = { @@ -275,101 +275,101 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - datacenter=dict( + kube_version=dict( required=False, type='str'), - default_pool_size=dict( - required=False, - type='int'), - taints=dict( + service_subnet=dict( required=False, - elements='', - type='list'), - force_delete_storage=dict( + type='str'), + no_subnet=dict( required=False, type='bool'), - tags=dict( - required=False, - elements='', - type='list'), - disk_encryption=dict( + force_delete_storage=dict( required=False, type='bool'), - retry_patch_version=dict( - required=False, - type='int'), - update_all_workers=dict( + private_service_endpoint=dict( required=False, type='bool'), - wait_till=dict( + datacenter=dict( required=False, type='str'), - machine_type=dict( + workers_info=dict( required=False, - type='str'), - hardware=dict( + elements='', + type='list'), + resource_group_id=dict( required=False, type='str'), - private_vlan_id=dict( + hardware=dict( required=False, type='str'), - labels=dict( + subnet_id=dict( required=False, elements='', - type='dict'), - resource_group_id=dict( - required=False, - type='str'), + type='list'), webhook=dict( required=False, elements='', type='list'), - gateway_enabled=dict( + labels=dict( + required=False, + elements='', + type='dict'), + disk_encryption=dict( required=False, type='bool'), - pod_subnet=dict( + patch_version=dict( required=False, type='str'), - no_subnet=dict( + retry_patch_version=dict( required=False, - type='bool'), - name=dict( + type='int'), + machine_type=dict( required=False, type='str'), - kube_version=dict( + name=dict( required=False, type='str'), - entitlement=dict( + kms_config=dict( required=False, - type='str'), - public_service_endpoint=dict( + elements='', + type='list'), + gateway_enabled=dict( required=False, type='bool'), - patch_version=dict( + public_vlan_id=dict( required=False, type='str'), - public_vlan_id=dict( + pod_subnet=dict( required=False, type='str'), - private_service_endpoint=dict( + private_vlan_id=dict( + required=False, + type='str'), + default_pool_size=dict( + required=False, + type='int'), + wait_for_worker_update=dict( required=False, type='bool'), - service_subnet=dict( + wait_till=dict( required=False, type='str'), - subnet_id=dict( + tags=dict( required=False, elements='', type='list'), - kms_config=dict( + public_service_endpoint=dict( required=False, - elements='', - type='list'), - workers_info=dict( + type='bool'), + taints=dict( required=False, elements='', type='list'), - wait_for_worker_update=dict( + entitlement=dict( + required=False, + type='str'), + update_all_workers=dict( required=False, type='bool'), id=dict( diff --git a/plugins/modules/ibm_container_cluster_config_info.py b/plugins/modules/ibm_container_cluster_config_info.py index 3152e8dfa..bcc7d81ad 100644 --- a/plugins/modules/ibm_container_cluster_config_info.py +++ b/plugins/modules/ibm_container_cluster_config_info.py @@ -26,12 +26,12 @@ - The name/id of the cluster required: True type: str - download: + network: description: - - If set to false will not download the config, otherwise they are downloaded each time but onto the same path for a given cluster name/id + - If set to true will download the Calico network config with the Admin config required: False type: bool - default: True + default: False config_dir: description: - The directory where the cluster config to be downloaded. Default is home directory @@ -48,12 +48,12 @@ required: False type: bool default: False - network: + download: description: - - If set to true will download the Calico network config with the Admin config + - If set to false will not download the config, otherwise they are downloaded each time but onto the same path for a given cluster name/id required: False type: bool - default: False + default: True ibmcloud_api_key: description: - The IBM Cloud API key to authenticate with the IBM Cloud @@ -73,11 +73,11 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'cluster_name_id', - 'download', + 'network', 'config_dir', 'resource_group_id', 'admin', - 'network', + 'download', ] @@ -91,7 +91,7 @@ cluster_name_id=dict( required=True, type='str'), - download=dict( + network=dict( required=False, type='bool'), config_dir=dict( @@ -103,7 +103,7 @@ admin=dict( required=False, type='bool'), - network=dict( + download=dict( required=False, type='bool'), ibmcloud_api_key=dict( diff --git a/plugins/modules/ibm_container_cluster_feature.py b/plugins/modules/ibm_container_cluster_feature.py index c0e91374f..75e5b1587 100644 --- a/plugins/modules/ibm_container_cluster_feature.py +++ b/plugins/modules/ibm_container_cluster_feature.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + resource_group_id: + description: + - ID of the resource group. + required: False + type: str cluster: description: - (Required for new resource) Cluster name of ID @@ -49,11 +54,6 @@ required: False type: bool default: True - resource_group_id: - description: - - ID of the resource group. - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -85,12 +85,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'resource_group_id', 'cluster', 'public_service_endpoint', 'private_service_endpoint', 'refresh_api_servers', 'reload_workers', - 'resource_group_id', ] # Params for Data source @@ -107,6 +107,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + resource_group_id=dict( + required=False, + type='str'), cluster=dict( required=False, type='str'), @@ -122,9 +125,6 @@ reload_workers=dict( required=False, type='bool'), - resource_group_id=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_cluster_info.py b/plugins/modules/ibm_container_cluster_info.py index 9ff6c4cfa..d82d5e0ec 100644 --- a/plugins/modules/ibm_container_cluster_info.py +++ b/plugins/modules/ibm_container_cluster_info.py @@ -21,28 +21,28 @@ - Terraform v0.12.20 options: - resource_group_id: + list_bounded_services: description: - - ID of the resource group. + - If set to false bounded services won't be listed. required: False - type: str + type: bool + default: True name: description: - Name or id of the cluster required: False type: str - list_bounded_services: - description: - - If set to false bounded services won't be listed. - required: False - type: bool - default: True alb_type: description: - None required: False type: str default: all + resource_group_id: + description: + - ID of the resource group. + required: False + type: str ibmcloud_api_key: description: - The IBM Cloud API key to authenticate with the IBM Cloud @@ -60,10 +60,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'resource_group_id', - 'name', 'list_bounded_services', + 'name', 'alb_type', + 'resource_group_id', ] @@ -74,18 +74,18 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - resource_group_id=dict( + list_bounded_services=dict( required=False, - type='str'), + type='bool'), name=dict( required=False, type='str'), - list_bounded_services=dict( - required=False, - type='bool'), alb_type=dict( required=False, type='str'), + resource_group_id=dict( + required=False, + type='str'), ibmcloud_api_key=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_container_cluster_worker_info.py b/plugins/modules/ibm_container_cluster_worker_info.py index e5e449b99..a73057d15 100644 --- a/plugins/modules/ibm_container_cluster_worker_info.py +++ b/plugins/modules/ibm_container_cluster_worker_info.py @@ -21,16 +21,16 @@ - Terraform v0.12.20 options: - resource_group_id: - description: - - ID of the resource group. - required: False - type: str worker_id: description: - ID of the worker required: True type: str + resource_group_id: + description: + - ID of the resource group. + required: False + type: str ibmcloud_api_key: description: - The IBM Cloud API key to authenticate with the IBM Cloud @@ -49,8 +49,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'resource_group_id', 'worker_id', + 'resource_group_id', ] @@ -61,12 +61,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - resource_group_id=dict( - required=False, - type='str'), worker_id=dict( required=True, type='str'), + resource_group_id=dict( + required=False, + type='str'), ibmcloud_api_key=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_container_nlb_dns.py b/plugins/modules/ibm_container_nlb_dns.py index 2350e7f2d..7c1eb7170 100644 --- a/plugins/modules/ibm_container_nlb_dns.py +++ b/plugins/modules/ibm_container_nlb_dns.py @@ -27,11 +27,6 @@ - The ID of the resource group that the cluster is in. To check the resource group ID of the cluster, use the GET /v1/clusters/idOrName API. To list available resource group IDs, run ibmcloud resource groups. required: False type: str - cluster: - description: - - (Required for new resource) The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. - required: True - type: str nlb_host: description: - (Required for new resource) @@ -43,6 +38,11 @@ required: True type: list elements: str + cluster: + description: + - (Required for new resource) The name or ID of the cluster. To list the clusters that you have access to, use the `GET /v1/clusters` API or run `ibmcloud ks cluster ls`. + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -69,17 +69,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('cluster', 'str'), ('nlb_host', 'str'), ('nlb_ips', 'list'), + ('cluster', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'resource_group_id', - 'cluster', 'nlb_host', 'nlb_ips', + 'cluster', ] # Params for Data source @@ -101,9 +101,6 @@ resource_group_id=dict( required=False, type='str'), - cluster=dict( - required=False, - type='str'), nlb_host=dict( required=False, type='str'), @@ -111,6 +108,9 @@ required=False, elements='', type='list'), + cluster=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_storage_attachment.py b/plugins/modules/ibm_container_storage_attachment.py index 0f5960c3e..c15a20922 100644 --- a/plugins/modules/ibm_container_storage_attachment.py +++ b/plugins/modules/ibm_container_storage_attachment.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - volume: - description: - - (Required for new resource) VPC Volume ID - required: True - type: str cluster: description: - (Required for new resource) Cluster name or ID @@ -42,6 +37,11 @@ - ID of the resource group. required: False type: str + volume: + description: + - (Required for new resource) VPC Volume ID + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -68,31 +68,31 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('volume', 'str'), ('cluster', 'str'), ('worker', 'str'), + ('volume', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'volume', 'cluster', 'worker', 'resource_group_id', + 'volume', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ + ('cluster', 'str'), ('worker', 'str'), ('volume_attachment_id', 'str'), - ('cluster', 'str'), ] TL_ALL_PARAMETERS_DS = [ + 'cluster', 'worker', 'resource_group_id', 'volume_attachment_id', - 'cluster', ] TL_CONFLICTS_MAP = { @@ -102,9 +102,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - volume=dict( - required=False, - type='str'), cluster=dict( required=False, type='str'), @@ -114,6 +111,9 @@ resource_group_id=dict( required=False, type='str'), + volume=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_storage_attachment_info.py b/plugins/modules/ibm_container_storage_attachment_info.py index 769e6f399..ab260a411 100644 --- a/plugins/modules/ibm_container_storage_attachment_info.py +++ b/plugins/modules/ibm_container_storage_attachment_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + cluster: + description: + - Cluster name or ID + required: True + type: str worker: description: - Worker node ID @@ -36,11 +41,6 @@ - The volume attachment ID required: True type: str - cluster: - description: - - Cluster name or ID - required: True - type: str ibmcloud_api_key: description: - The IBM Cloud API key to authenticate with the IBM Cloud @@ -54,17 +54,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('cluster', 'str'), ('worker', 'str'), ('volume_attachment_id', 'str'), - ('cluster', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'cluster', 'worker', 'resource_group_id', 'volume_attachment_id', - 'cluster', ] @@ -75,6 +75,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + cluster=dict( + required=True, + type='str'), worker=dict( required=True, type='str'), @@ -84,9 +87,6 @@ volume_attachment_id=dict( required=True, type='str'), - cluster=dict( - required=True, - type='str'), ibmcloud_api_key=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_container_vpc_alb.py b/plugins/modules/ibm_container_vpc_alb.py index 1998171e2..d57729f29 100644 --- a/plugins/modules/ibm_container_vpc_alb.py +++ b/plugins/modules/ibm_container_vpc_alb.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + disable_deployment: + description: + - Disable the ALB instance in the cluster + required: False + type: bool + enable: + description: + - Enable the ALB instance in the cluster + required: False + type: bool alb_id: description: - (Required for new resource) ALB ID @@ -32,16 +42,6 @@ - ID of the resource group. required: False type: str - enable: - description: - - Enable the ALB instance in the cluster - required: False - type: bool - disable_deployment: - description: - - Disable the ALB instance in the cluster - required: False - type: bool id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -73,10 +73,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'disable_deployment', + 'enable', 'alb_id', 'resource_group_id', - 'enable', - 'disable_deployment', ] # Params for Data source @@ -90,26 +90,26 @@ ] TL_CONFLICTS_MAP = { - 'enable': ['disable_deployment'], 'disable_deployment': ['enable'], + 'enable': ['disable_deployment'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + disable_deployment=dict( + required=False, + type='bool'), + enable=dict( + required=False, + type='bool'), alb_id=dict( required=False, type='str'), resource_group_id=dict( required=False, type='str'), - enable=dict( - required=False, - type='bool'), - disable_deployment=dict( - required=False, - type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_vpc_alb_create.py b/plugins/modules/ibm_container_vpc_alb_create.py index 262b32715..2260c84fd 100644 --- a/plugins/modules/ibm_container_vpc_alb_create.py +++ b/plugins/modules/ibm_container_vpc_alb_create.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + zone: + description: + - (Required for new resource) The zone where you want to deploy the ALB. + required: True + type: str + cluster: + description: + - (Required for new resource) The ID of the cluster that the ALB belongs to. + required: True + type: str type: description: - (Required for new resource) The type of ALB that you want to create. @@ -37,16 +47,6 @@ - Enable the ALB instance in the cluster required: False type: bool - zone: - description: - - (Required for new resource) The zone where you want to deploy the ALB. - required: True - type: str - cluster: - description: - - (Required for new resource) The ID of the cluster that the ALB belongs to. - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -73,18 +73,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('type', 'str'), ('zone', 'str'), ('cluster', 'str'), + ('type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'zone', + 'cluster', 'type', 'resource_group_id', 'enable', - 'zone', - 'cluster', ] # Params for Data source @@ -101,6 +101,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + zone=dict( + required=False, + type='str'), + cluster=dict( + required=False, + type='str'), type=dict( required=False, type='str'), @@ -110,12 +116,6 @@ enable=dict( required=False, type='bool'), - zone=dict( - required=False, - type='str'), - cluster=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_vpc_cluster.py b/plugins/modules/ibm_container_vpc_cluster.py index cdd1170d2..7b2a54263 100644 --- a/plugins/modules/ibm_container_vpc_cluster.py +++ b/plugins/modules/ibm_container_vpc_cluster.py @@ -22,34 +22,6 @@ - Terraform v0.12.20 options: - wait_for_worker_update: - description: - - Wait for worker node to update during kube version update. - required: False - type: bool - default: True - kube_version: - description: - - Kubernetes version - required: False - type: str - disable_public_service_endpoint: - description: - - Boolean value true if Public service endpoint to be disabled - required: False - type: bool - default: False - force_delete_storage: - description: - - Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered - required: False - type: bool - default: False - service_subnet: - description: - - Custom subnet CIDR to provide private IP addresses for services - required: False - type: str worker_count: description: - Number of worker nodes in the cluster @@ -61,88 +33,116 @@ - A standard cloud object storage instance CRN to back up the internal registry in your OpenShift on VPC Gen 2 cluster required: False type: str - flavor: + kube_version: description: - - (Required for new resource) Cluster nodes flavour - required: True + - Kubernetes version + required: False type: str retry_patch_version: description: - Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails required: False type: int - pod_subnet: + worker_labels: description: - - Custom subnet CIDR to provide private IP addresses for pods + - Labels for default worker pool required: False - type: str + type: dict + elements: str tags: description: - List of tags for the resources required: False type: list elements: str - wait_till: + flavor: description: - - wait_till can be configured for Master Ready, One worker Ready or Ingress Ready - required: False + - (Required for new resource) Cluster nodes flavour + required: True type: str - default: IngressReady kms_config: description: - Enables KMS on a given cluster required: False type: list elements: dict - zones: - description: - - (Required for new resource) Zone info - required: True - type: list - elements: dict name: description: - (Required for new resource) The cluster name required: True type: str - resource_group_id: + update_all_workers: description: - - ID of the resource group. + - Updates all the woker nodes if sets to true required: False + type: bool + default: False + wait_for_worker_update: + description: + - Wait for worker node to update during kube version update. + required: False + type: bool + default: True + vpc_id: + description: + - (Required for new resource) The vpc id where the cluster is + required: True type: str + zones: + description: + - (Required for new resource) Zone info + required: True + type: list + elements: dict patch_version: description: - Kubernetes patch version required: False type: str - worker_labels: + service_subnet: description: - - Labels for default worker pool + - Custom subnet CIDR to provide private IP addresses for services required: False - type: dict - elements: str + type: str + disable_public_service_endpoint: + description: + - Boolean value true if Public service endpoint to be disabled + required: False + type: bool + default: False + pod_subnet: + description: + - Custom subnet CIDR to provide private IP addresses for pods + required: False + type: str taints: description: - WorkerPool Taints required: False type: list elements: dict - entitlement: + wait_till: description: - - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + - wait_till can be configured for Master Ready, One worker Ready or Ingress Ready required: False type: str - vpc_id: - description: - - (Required for new resource) The vpc id where the cluster is - required: True - type: str - update_all_workers: + default: IngressReady + force_delete_storage: description: - - Updates all the woker nodes if sets to true + - Force the removal of a cluster and its persistent storage. Deleted data cannot be recovered required: False type: bool default: False + entitlement: + description: + - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + required: False + type: str + resource_group_id: + description: + - ID of the resource group. + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -170,35 +170,35 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('flavor', 'str'), - ('zones', 'list'), ('name', 'str'), ('vpc_id', 'str'), + ('zones', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'wait_for_worker_update', - 'kube_version', - 'disable_public_service_endpoint', - 'force_delete_storage', - 'service_subnet', 'worker_count', 'cos_instance_crn', - 'flavor', + 'kube_version', 'retry_patch_version', - 'pod_subnet', + 'worker_labels', 'tags', - 'wait_till', + 'flavor', 'kms_config', - 'zones', 'name', - 'resource_group_id', + 'update_all_workers', + 'wait_for_worker_update', + 'vpc_id', + 'zones', 'patch_version', - 'worker_labels', + 'service_subnet', + 'disable_public_service_endpoint', + 'pod_subnet', 'taints', + 'wait_till', + 'force_delete_storage', 'entitlement', - 'vpc_id', - 'update_all_workers', + 'resource_group_id', ] # Params for Data source @@ -206,10 +206,10 @@ ] TL_ALL_PARAMETERS_DS = [ - 'cluster_name_id', 'alb_type', - 'name', 'resource_group_id', + 'cluster_name_id', + 'name', ] TL_CONFLICTS_MAP = { @@ -219,77 +219,77 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - wait_for_worker_update=dict( - required=False, - type='bool'), - kube_version=dict( - required=False, - type='str'), - disable_public_service_endpoint=dict( - required=False, - type='bool'), - force_delete_storage=dict( - required=False, - type='bool'), - service_subnet=dict( - required=False, - type='str'), worker_count=dict( required=False, type='int'), cos_instance_crn=dict( required=False, type='str'), - flavor=dict( + kube_version=dict( required=False, type='str'), retry_patch_version=dict( required=False, type='int'), - pod_subnet=dict( + worker_labels=dict( required=False, - type='str'), + elements='', + type='dict'), tags=dict( required=False, elements='', type='list'), - wait_till=dict( + flavor=dict( required=False, type='str'), kms_config=dict( required=False, elements='', type='list'), + name=dict( + required=False, + type='str'), + update_all_workers=dict( + required=False, + type='bool'), + wait_for_worker_update=dict( + required=False, + type='bool'), + vpc_id=dict( + required=False, + type='str'), zones=dict( required=False, elements='', type='list'), - name=dict( + patch_version=dict( required=False, type='str'), - resource_group_id=dict( + service_subnet=dict( required=False, type='str'), - patch_version=dict( + disable_public_service_endpoint=dict( required=False, - type='str'), - worker_labels=dict( + type='bool'), + pod_subnet=dict( required=False, - elements='', - type='dict'), + type='str'), taints=dict( required=False, elements='', type='list'), - entitlement=dict( + wait_till=dict( required=False, type='str'), - vpc_id=dict( + force_delete_storage=dict( + required=False, + type='bool'), + entitlement=dict( required=False, type='str'), - update_all_workers=dict( + resource_group_id=dict( required=False, - type='bool'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_vpc_cluster_alb_info.py b/plugins/modules/ibm_container_vpc_cluster_alb_info.py index bae416043..c8425bc0b 100644 --- a/plugins/modules/ibm_container_vpc_cluster_alb_info.py +++ b/plugins/modules/ibm_container_vpc_cluster_alb_info.py @@ -21,16 +21,16 @@ - Terraform v0.12.20 options: - resource_group_id: - description: - - ID of the resource group. - required: False - type: str alb_id: description: - ALB ID required: True type: str + resource_group_id: + description: + - ID of the resource group. + required: False + type: str ibmcloud_api_key: description: - The IBM Cloud API key to authenticate with the IBM Cloud @@ -49,8 +49,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'resource_group_id', 'alb_id', + 'resource_group_id', ] @@ -61,12 +61,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - resource_group_id=dict( - required=False, - type='str'), alb_id=dict( required=True, type='str'), + resource_group_id=dict( + required=False, + type='str'), ibmcloud_api_key=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_container_vpc_cluster_info.py b/plugins/modules/ibm_container_vpc_cluster_info.py index b385de255..280394e66 100644 --- a/plugins/modules/ibm_container_vpc_cluster_info.py +++ b/plugins/modules/ibm_container_vpc_cluster_info.py @@ -27,14 +27,14 @@ required: False type: str default: all - name: + resource_group_id: description: - - Name or id of the cluster + - ID of the resource group. required: False type: str - resource_group_id: + name: description: - - ID of the resource group. + - Name or id of the cluster required: False type: str ibmcloud_api_key: @@ -55,8 +55,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'alb_type', - 'name', 'resource_group_id', + 'name', ] @@ -70,10 +70,10 @@ alb_type=dict( required=False, type='str'), - name=dict( + resource_group_id=dict( required=False, type='str'), - resource_group_id=dict( + name=dict( required=False, type='str'), ibmcloud_api_key=dict( diff --git a/plugins/modules/ibm_container_vpc_cluster_worker_info.py b/plugins/modules/ibm_container_vpc_cluster_worker_info.py index eb39b64e5..215b87f60 100644 --- a/plugins/modules/ibm_container_vpc_cluster_worker_info.py +++ b/plugins/modules/ibm_container_vpc_cluster_worker_info.py @@ -21,11 +21,6 @@ - Terraform v0.12.20 options: - resource_group_id: - description: - - ID of the resource group. - required: False - type: str cluster_name_id: description: - Name or ID of the cluster @@ -36,6 +31,11 @@ - ID of the worker required: True type: str + resource_group_id: + description: + - ID of the resource group. + required: False + type: str ibmcloud_api_key: description: - The IBM Cloud API key to authenticate with the IBM Cloud @@ -55,9 +55,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'resource_group_id', 'cluster_name_id', 'worker_id', + 'resource_group_id', ] @@ -68,15 +68,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - resource_group_id=dict( - required=False, - type='str'), cluster_name_id=dict( required=True, type='str'), worker_id=dict( required=True, type='str'), + resource_group_id=dict( + required=False, + type='str'), ibmcloud_api_key=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_container_vpc_cluster_worker_pool_info.py b/plugins/modules/ibm_container_vpc_cluster_worker_pool_info.py index f43edbc06..e0ce0fa9f 100644 --- a/plugins/modules/ibm_container_vpc_cluster_worker_pool_info.py +++ b/plugins/modules/ibm_container_vpc_cluster_worker_pool_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - cluster: + worker_pool_name: description: - - Cluster name + - worker pool name required: True type: str - worker_pool_name: + cluster: description: - - worker pool name + - Cluster name required: True type: str ibmcloud_api_key: @@ -44,14 +44,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('cluster', 'str'), ('worker_pool_name', 'str'), + ('cluster', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'cluster', 'worker_pool_name', + 'cluster', ] @@ -62,10 +62,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - cluster=dict( + worker_pool_name=dict( required=True, type='str'), - worker_pool_name=dict( + cluster=dict( required=True, type='str'), ibmcloud_api_key=dict( diff --git a/plugins/modules/ibm_container_vpc_worker_pool.py b/plugins/modules/ibm_container_vpc_worker_pool.py index 512285cf0..8abea274d 100644 --- a/plugins/modules/ibm_container_vpc_worker_pool.py +++ b/plugins/modules/ibm_container_vpc_worker_pool.py @@ -22,41 +22,30 @@ - Terraform v0.12.20 options: - worker_count: - description: - - (Required for new resource) The number of workers - required: True - type: int - cluster: - description: - - (Required for new resource) Cluster name - required: True - type: str - flavor: - description: - - (Required for new resource) cluster node falvor - required: True - type: str zones: description: - (Required for new resource) Zones info required: True type: list elements: dict - taints: - description: - - WorkerPool Taints - required: False - type: list - elements: dict resource_group_id: description: - ID of the resource group. required: False type: str - vpc_id: + entitlement: description: - - (Required for new resource) The vpc id where the cluster is + - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + required: False + type: str + cluster: + description: + - (Required for new resource) Cluster name + required: True + type: str + flavor: + description: + - (Required for new resource) cluster node falvor required: True type: str worker_pool_name: @@ -70,11 +59,22 @@ required: False type: dict elements: str - entitlement: + taints: description: - - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + - WorkerPool Taints required: False + type: list + elements: dict + vpc_id: + description: + - (Required for new resource) The vpc id where the cluster is + required: True type: str + worker_count: + description: + - (Required for new resource) The number of workers + required: True + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -101,26 +101,26 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('worker_count', 'int'), + ('zones', 'list'), ('cluster', 'str'), ('flavor', 'str'), - ('zones', 'list'), - ('vpc_id', 'str'), ('worker_pool_name', 'str'), + ('vpc_id', 'str'), + ('worker_count', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'worker_count', - 'cluster', - 'flavor', 'zones', - 'taints', 'resource_group_id', - 'vpc_id', + 'entitlement', + 'cluster', + 'flavor', 'worker_pool_name', 'labels', - 'entitlement', + 'taints', + 'vpc_id', + 'worker_count', ] # Params for Data source @@ -141,27 +141,20 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - worker_count=dict( - required=False, - type='int'), - cluster=dict( - required=False, - type='str'), - flavor=dict( - required=False, - type='str'), zones=dict( required=False, elements='', type='list'), - taints=dict( - required=False, - elements='', - type='list'), resource_group_id=dict( required=False, type='str'), - vpc_id=dict( + entitlement=dict( + required=False, + type='str'), + cluster=dict( + required=False, + type='str'), + flavor=dict( required=False, type='str'), worker_pool_name=dict( @@ -171,9 +164,16 @@ required=False, elements='', type='dict'), - entitlement=dict( + taints=dict( + required=False, + elements='', + type='list'), + vpc_id=dict( required=False, type='str'), + worker_count=dict( + required=False, + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_worker_pool.py b/plugins/modules/ibm_container_worker_pool.py index 4af31db8b..99c3c92b7 100644 --- a/plugins/modules/ibm_container_worker_pool.py +++ b/plugins/modules/ibm_container_worker_pool.py @@ -22,47 +22,53 @@ - Terraform v0.12.20 options: - machine_type: + hardware: description: - - (Required for new resource) worker nodes machine type - required: True + - Hardware type + required: False type: str + default: shared worker_pool_name: description: - (Required for new resource) worker pool name required: True type: str + size_per_zone: + description: + - (Required for new resource) Number of nodes per zone + required: True + type: int + entitlement: + description: + - Entitlement option reduces additional OCP Licence cost in Openshift Clusters + required: False + type: str taints: description: - WorkerPool Taints required: False type: list elements: dict - resource_group_id: - description: - - ID of the resource group. - required: False - type: str cluster: description: - (Required for new resource) Cluster name required: True type: str - hardware: + labels: description: - - Hardware type + - list of labels to worker pool + required: False + type: dict + elements: str + resource_group_id: + description: + - ID of the resource group. required: False type: str - default: shared - size_per_zone: + machine_type: description: - - (Required for new resource) Number of nodes per zone + - (Required for new resource) worker nodes machine type required: True - type: int - entitlement: - description: - - Entitlement option reduces additional OCP Licence cost in Openshift Clusters - required: False type: str disk_encryption: description: @@ -70,12 +76,6 @@ required: False type: bool default: True - labels: - description: - - list of labels to worker pool - required: False - type: dict - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -102,35 +102,35 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('machine_type', 'str'), ('worker_pool_name', 'str'), - ('cluster', 'str'), ('size_per_zone', 'int'), + ('cluster', 'str'), + ('machine_type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'machine_type', - 'worker_pool_name', - 'taints', - 'resource_group_id', - 'cluster', 'hardware', + 'worker_pool_name', 'size_per_zone', 'entitlement', - 'disk_encryption', + 'taints', + 'cluster', 'labels', + 'resource_group_id', + 'machine_type', + 'disk_encryption', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('cluster', 'str'), ('worker_pool_name', 'str'), + ('cluster', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'cluster', 'worker_pool_name', + 'cluster', ] TL_CONFLICTS_MAP = { @@ -140,38 +140,38 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - machine_type=dict( + hardware=dict( required=False, type='str'), worker_pool_name=dict( required=False, type='str'), + size_per_zone=dict( + required=False, + type='int'), + entitlement=dict( + required=False, + type='str'), taints=dict( required=False, elements='', type='list'), - resource_group_id=dict( - required=False, - type='str'), cluster=dict( required=False, type='str'), - hardware=dict( + labels=dict( required=False, - type='str'), - size_per_zone=dict( + elements='', + type='dict'), + resource_group_id=dict( required=False, - type='int'), - entitlement=dict( + type='str'), + machine_type=dict( required=False, type='str'), disk_encryption=dict( required=False, type='bool'), - labels=dict( - required=False, - elements='', - type='dict'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_container_worker_pool_info.py b/plugins/modules/ibm_container_worker_pool_info.py index b9d9cbd01..69599a22b 100644 --- a/plugins/modules/ibm_container_worker_pool_info.py +++ b/plugins/modules/ibm_container_worker_pool_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - cluster: + worker_pool_name: description: - - Name or ID of the cluster + - worker pool name required: True type: str - worker_pool_name: + cluster: description: - - worker pool name + - Name or ID of the cluster required: True type: str ibmcloud_api_key: @@ -44,14 +44,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('cluster', 'str'), ('worker_pool_name', 'str'), + ('cluster', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'cluster', 'worker_pool_name', + 'cluster', ] @@ -62,10 +62,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - cluster=dict( + worker_pool_name=dict( required=True, type='str'), - worker_pool_name=dict( + cluster=dict( required=True, type='str'), ibmcloud_api_key=dict( diff --git a/plugins/modules/ibm_container_worker_pool_zone_attachment.py b/plugins/modules/ibm_container_worker_pool_zone_attachment.py index 24f3b2b50..77930b323 100644 --- a/plugins/modules/ibm_container_worker_pool_zone_attachment.py +++ b/plugins/modules/ibm_container_worker_pool_zone_attachment.py @@ -22,27 +22,11 @@ - Terraform v0.12.20 options: - wait_till_albs: - description: - - wait_till_albs can be configured to wait for albs during the worker pool zone attachment. - required: False - type: bool - default: True - zone: - description: - - (Required for new resource) Zone name - required: True - type: str cluster: description: - (Required for new resource) cluster name or ID required: True type: str - worker_pool: - description: - - (Required for new resource) Workerpool name - required: True - type: str private_vlan_id: description: - None @@ -58,6 +42,22 @@ - ID of the resource group. required: False type: str + wait_till_albs: + description: + - wait_till_albs can be configured to wait for albs during the worker pool zone attachment. + required: False + type: bool + default: True + zone: + description: + - (Required for new resource) Zone name + required: True + type: str + worker_pool: + description: + - (Required for new resource) Workerpool name + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -84,20 +84,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('zone', 'str'), ('cluster', 'str'), + ('zone', 'str'), ('worker_pool', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'wait_till_albs', - 'zone', 'cluster', - 'worker_pool', 'private_vlan_id', 'public_vlan_id', 'resource_group_id', + 'wait_till_albs', + 'zone', + 'worker_pool', ] # Params for Data source @@ -114,18 +114,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - wait_till_albs=dict( - required=False, - type='bool'), - zone=dict( - required=False, - type='str'), cluster=dict( required=False, type='str'), - worker_pool=dict( - required=False, - type='str'), private_vlan_id=dict( required=False, type='str'), @@ -135,6 +126,15 @@ resource_group_id=dict( required=False, type='str'), + wait_till_albs=dict( + required=False, + type='bool'), + zone=dict( + required=False, + type='str'), + worker_pool=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cos_bucket.py b/plugins/modules/ibm_cos_bucket.py index ac8e87bd2..9e07b6311 100644 --- a/plugins/modules/ibm_cos_bucket.py +++ b/plugins/modules/ibm_cos_bucket.py @@ -22,29 +22,12 @@ - Terraform v0.12.20 options: - force_delete: - description: - - COS buckets need to be empty before they can be deleted. force_delete option empty the bucket and delete it. - required: False - type: bool - default: True - cross_region_location: - description: - - Cros region location info - required: False - type: str metrics_monitoring: description: - Enables sending metrics to IBM Cloud Monitoring. required: False type: list elements: dict - archive_rule: - description: - - Enable configuration archive_rule (glacier/accelerated) to COS Bucket after a defined period of time - required: False - type: list - elements: dict expire_rule: description: - Enable configuration expire_rule to COS Bucket after a defined period of time @@ -57,14 +40,9 @@ required: False type: list elements: dict - key_protect: - description: - - CRN of the key you want to use data at rest encryption - required: False - type: str - region_location: + cross_region_location: description: - - Region Location info. + - Cros region location info required: False type: str storage_class: @@ -72,53 +50,59 @@ - (Required for new resource) Storage class info required: True type: str - retention_rule: - description: - - A retention policy is enabled at the IBM Cloud Object Storage bucket level. Minimum, maximum and default retention period are defined by this policy and apply to all objects in the bucket. - required: False - type: list - elements: dict - hard_quota: + force_delete: description: - - sets a maximum amount of storage (in bytes) available for a bucket + - COS buckets need to be empty before they can be deleted. force_delete option empty the bucket and delete it. required: False - type: int + type: bool + default: True bucket_name: description: - (Required for new resource) COS Bucket name required: True type: str - resource_instance_id: + region_location: description: - - (Required for new resource) resource instance ID - required: True + - Region Location info. + required: False type: str - allowed_ip: + activity_tracking: description: - - List of IPv4 or IPv6 addresses + - Enables sending log data to Activity Tracker and LogDNA to provide visibility into object read and write events required: False type: list - elements: str + elements: dict abort_incomplete_multipart_upload_days: description: - Enable abort incomplete multipart upload to COS Bucket after a defined period of time required: False type: list elements: dict + archive_rule: + description: + - Enable configuration archive_rule (glacier/accelerated) to COS Bucket after a defined period of time + required: False + type: list + elements: dict + resource_instance_id: + description: + - (Required for new resource) resource instance ID + required: True + type: str single_site_location: description: - single site location info required: False type: str - endpoint_type: + allowed_ip: description: - - public or private + - List of IPv4 or IPv6 addresses required: False - type: str - default: public - activity_tracking: + type: list + elements: str + retention_rule: description: - - Enables sending log data to Activity Tracker and LogDNA to provide visibility into object read and write events + - A retention policy is enabled at the IBM Cloud Object Storage bucket level. Minimum, maximum and default retention period are defined by this policy and apply to all objects in the bucket. required: False type: list elements: dict @@ -128,6 +112,22 @@ required: False type: list elements: dict + hard_quota: + description: + - sets a maximum amount of storage (in bytes) available for a bucket + required: False + type: int + key_protect: + description: + - CRN of the key you want to use data at rest encryption + required: False + type: str + endpoint_type: + description: + - public or private + required: False + type: str + default: public id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -181,46 +181,46 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'force_delete', - 'cross_region_location', 'metrics_monitoring', - 'archive_rule', 'expire_rule', 'object_versioning', - 'key_protect', - 'region_location', + 'cross_region_location', 'storage_class', - 'retention_rule', - 'hard_quota', + 'force_delete', 'bucket_name', - 'resource_instance_id', - 'allowed_ip', + 'region_location', + 'activity_tracking', 'abort_incomplete_multipart_upload_days', + 'archive_rule', + 'resource_instance_id', 'single_site_location', - 'endpoint_type', - 'activity_tracking', + 'allowed_ip', + 'retention_rule', 'noncurrent_version_expiration', + 'hard_quota', + 'key_protect', + 'endpoint_type', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('bucket_type', 'str'), ('bucket_region', 'str'), - ('bucket_name', 'str'), ('resource_instance_id', 'str'), + ('bucket_name', 'str'), + ('bucket_type', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'bucket_type', - 'endpoint_type', 'bucket_region', - 'bucket_name', 'resource_instance_id', + 'bucket_name', + 'bucket_type', + 'endpoint_type', ] TL_CONFLICTS_MAP = { - 'cross_region_location': ['region_location', 'single_site_location'], 'object_versioning': ['retention_rule'], + 'cross_region_location': ['region_location', 'single_site_location'], 'region_location': ['cross_region_location', 'single_site_location'], 'single_site_location': ['region_location', 'cross_region_location'], } @@ -229,20 +229,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - force_delete=dict( - required=False, - type='bool'), - cross_region_location=dict( - required=False, - type='str'), metrics_monitoring=dict( required=False, elements='', type='list'), - archive_rule=dict( - required=False, - elements='', - type='list'), expire_rule=dict( required=False, elements='', @@ -251,29 +241,22 @@ required=False, elements='', type='list'), - key_protect=dict( - required=False, - type='str'), - region_location=dict( + cross_region_location=dict( required=False, type='str'), storage_class=dict( required=False, type='str'), - retention_rule=dict( - required=False, - elements='', - type='list'), - hard_quota=dict( + force_delete=dict( required=False, - type='int'), + type='bool'), bucket_name=dict( required=False, type='str'), - resource_instance_id=dict( + region_location=dict( required=False, type='str'), - allowed_ip=dict( + activity_tracking=dict( required=False, elements='', type='list'), @@ -281,13 +264,21 @@ required=False, elements='', type='list'), - single_site_location=dict( + archive_rule=dict( + required=False, + elements='', + type='list'), + resource_instance_id=dict( required=False, type='str'), - endpoint_type=dict( + single_site_location=dict( required=False, type='str'), - activity_tracking=dict( + allowed_ip=dict( + required=False, + elements='', + type='list'), + retention_rule=dict( required=False, elements='', type='list'), @@ -295,6 +286,15 @@ required=False, elements='', type='list'), + hard_quota=dict( + required=False, + type='int'), + key_protect=dict( + required=False, + type='str'), + endpoint_type=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cos_bucket_info.py b/plugins/modules/ibm_cos_bucket_info.py index 2d8072b5d..843024b0b 100644 --- a/plugins/modules/ibm_cos_bucket_info.py +++ b/plugins/modules/ibm_cos_bucket_info.py @@ -21,18 +21,12 @@ - Terraform v0.12.20 options: - bucket_type: + bucket_region: description: - None required: True type: str - endpoint_type: - description: - - public or private - required: False - type: str - default: public - bucket_region: + resource_instance_id: description: - None required: True @@ -42,11 +36,17 @@ - None required: True type: str - resource_instance_id: + bucket_type: description: - None required: True type: str + endpoint_type: + description: + - public or private + required: False + type: str + default: public iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -80,19 +80,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('bucket_type', 'str'), ('bucket_region', 'str'), - ('bucket_name', 'str'), ('resource_instance_id', 'str'), + ('bucket_name', 'str'), + ('bucket_type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'bucket_type', - 'endpoint_type', 'bucket_region', - 'bucket_name', 'resource_instance_id', + 'bucket_name', + 'bucket_type', + 'endpoint_type', ] @@ -103,21 +103,21 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - bucket_type=dict( + bucket_region=dict( required=True, type='str'), - endpoint_type=dict( - required=False, - type='str'), - bucket_region=dict( + resource_instance_id=dict( required=True, type='str'), bucket_name=dict( required=True, type='str'), - resource_instance_id=dict( + bucket_type=dict( required=True, type='str'), + endpoint_type=dict( + required=False, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_cos_bucket_object.py b/plugins/modules/ibm_cos_bucket_object.py index 22f5eb8f1..a3560b9f0 100644 --- a/plugins/modules/ibm_cos_bucket_object.py +++ b/plugins/modules/ibm_cos_bucket_object.py @@ -22,25 +22,14 @@ - Terraform v0.12.20 options: - content_base64: - description: - - COS object content in base64 encoding - required: False - type: str - force_delete: + etag: description: - - COS buckets need to be empty before they can be deleted. force_delete option empty the bucket and delete it. + - COS object MD5 hexdigest required: False - type: bool - default: True - bucket_location: - description: - - (Required for new resource) COS bucket location - required: True type: str - content: + content_base64: description: - - COS object content + - COS object content in base64 encoding required: False type: str endpoint_type: @@ -54,21 +43,32 @@ - (Required for new resource) COS bucket CRN required: True type: str - key: + bucket_location: description: - - (Required for new resource) COS object key + - (Required for new resource) COS bucket location required: True type: str - etag: + content: description: - - COS object MD5 hexdigest + - COS object content required: False type: str + force_delete: + description: + - COS buckets need to be empty before they can be deleted. force_delete option empty the bucket and delete it. + required: False + type: bool + default: True content_file: description: - COS object content file path required: False type: str + key: + description: + - (Required for new resource) COS object key + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -115,22 +115,22 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('bucket_location', 'str'), ('bucket_crn', 'str'), + ('bucket_location', 'str'), ('key', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'etag', 'content_base64', - 'force_delete', - 'bucket_location', - 'content', 'endpoint_type', 'bucket_crn', - 'key', - 'etag', + 'bucket_location', + 'content', + 'force_delete', 'content_file', + 'key', ] # Params for Data source @@ -142,8 +142,8 @@ TL_ALL_PARAMETERS_DS = [ 'bucket_crn', - 'key', 'endpoint_type', + 'key', 'bucket_location', ] @@ -157,16 +157,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - content_base64=dict( - required=False, - type='str'), - force_delete=dict( - required=False, - type='bool'), - bucket_location=dict( + etag=dict( required=False, type='str'), - content=dict( + content_base64=dict( required=False, type='str'), endpoint_type=dict( @@ -175,15 +169,21 @@ bucket_crn=dict( required=False, type='str'), - key=dict( + bucket_location=dict( required=False, type='str'), - etag=dict( + content=dict( required=False, type='str'), + force_delete=dict( + required=False, + type='bool'), content_file=dict( required=False, type='str'), + key=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_cos_bucket_object_info.py b/plugins/modules/ibm_cos_bucket_object_info.py index 6ed71ba4a..18942a337 100644 --- a/plugins/modules/ibm_cos_bucket_object_info.py +++ b/plugins/modules/ibm_cos_bucket_object_info.py @@ -26,17 +26,17 @@ - COS bucket CRN required: True type: str - key: - description: - - COS object key - required: True - type: str endpoint_type: description: - COS endpoint type: public, private, direct required: False type: str default: public + key: + description: + - COS object key + required: True + type: str bucket_location: description: - COS bucket location @@ -83,8 +83,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'bucket_crn', - 'key', 'endpoint_type', + 'key', 'bucket_location', ] @@ -99,12 +99,12 @@ bucket_crn=dict( required=True, type='str'), - key=dict( - required=True, - type='str'), endpoint_type=dict( required=False, type='str'), + key=dict( + required=True, + type='str'), bucket_location=dict( required=True, type='str'), diff --git a/plugins/modules/ibm_cr_namespace.py b/plugins/modules/ibm_cr_namespace.py index 9ee94af3c..9c809ecc5 100644 --- a/plugins/modules/ibm_cr_namespace.py +++ b/plugins/modules/ibm_cr_namespace.py @@ -22,12 +22,6 @@ - Terraform v0.12.20 options: - tags: - description: - - List of tags - required: False - type: list - elements: str name: description: - (Required for new resource) The name of the namespace. @@ -38,6 +32,12 @@ - The ID of the resource group that the namespace will be created within. required: False type: str + tags: + description: + - List of tags + required: False + type: list + elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -89,9 +89,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'tags', 'name', 'resource_group_id', + 'tags', ] # Params for Data source @@ -108,16 +108,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - tags=dict( - required=False, - elements='', - type='list'), name=dict( required=False, type='str'), resource_group_id=dict( required=False, type='str'), + tags=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_database.py b/plugins/modules/ibm_database.py index bf3265b66..7ca6ee16c 100644 --- a/plugins/modules/ibm_database.py +++ b/plugins/modules/ibm_database.py @@ -22,35 +22,31 @@ - Terraform v0.12.20 options: - configuration: + node_count: description: - - The configuration in JSON format + - Total number of nodes in the cluster required: False - type: str - version: + type: int + service_endpoints: description: - - The database version to provision if specified + - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. required: False type: str - plan_validation: - description: - - For elasticsearch and postgres perform database parameter validation during the plan phase. Otherwise, database parameter validation happens in apply phase. - required: False - type: bool - default: True - remote_leader_id: + default: public + whitelist: description: - - The CRN of leader database + - None required: False - type: str - point_in_time_recovery_deployment_id: + type: list + elements: dict + plan: description: - - The CRN of source instance - required: False + - (Required for new resource) The plan type of the Database instance + required: True type: str - point_in_time_recovery_time: + version: description: - - The point in time recovery time stamp of the deployed instance + - The database version to provision if specified required: False type: str members_disk_allocation_mb: @@ -58,21 +54,22 @@ - Disk allocation required for cluster required: False type: int - node_count: + node_cpu_allocation_count: description: - - Total number of nodes in the cluster + - CPU allocation per node required: False type: int - backup_id: + point_in_time_recovery_time: description: - - The CRN of backup source database + - The point in time recovery time stamp of the deployed instance required: False type: str - name: + users: description: - - (Required for new resource) Resource instance name for example, my Database instance - required: True - type: str + - None + required: False + type: list + elements: dict resource_group_id: description: - The id of the resource group in which the Database instance is present @@ -83,40 +80,50 @@ - Memory allocation per node required: False type: int - members_memory_allocation_mb: + configuration: description: - - Memory allocation required for cluster + - The configuration in JSON format required: False - type: int + type: str members_cpu_allocation_count: description: - CPU allocation required for cluster required: False type: int - tags: + backup_id: description: - - None + - The CRN of backup source database required: False - type: list - elements: str + type: str + remote_leader_id: + description: + - The CRN of leader database + required: False + type: str service: description: - (Required for new resource) The name of the Cloud Internet database service required: True type: str - plan: + members_memory_allocation_mb: description: - - (Required for new resource) The plan type of the Database instance - required: True - type: str - adminpassword: + - Memory allocation required for cluster + required: False + type: int + auto_scaling: description: - - The admin user password for the instance + - ICD Auto Scaling required: False + type: list + elements: dict + name: + description: + - (Required for new resource) Resource instance name for example, my Database instance + required: True type: str - key_protect_key: + key_protect_instance: description: - - The CRN of Key protect key + - The CRN of Key protect instance required: False type: str backup_encryption_key_crn: @@ -124,50 +131,43 @@ - The Backup Encryption Key CRN required: False type: str - users: + adminpassword: description: - - None + - The admin user password for the instance required: False - type: list - elements: dict - node_disk_allocation_mb: + type: str + point_in_time_recovery_deployment_id: description: - - Disk allocation per node + - The CRN of source instance required: False - type: int - node_cpu_allocation_count: + type: str + plan_validation: description: - - CPU allocation per node + - For elasticsearch and postgres perform database parameter validation during the plan phase. Otherwise, database parameter validation happens in apply phase. required: False - type: int - service_endpoints: + type: bool + default: True + key_protect_key: description: - - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. + - The CRN of Key protect key required: False type: str - default: public + tags: + description: + - None + required: False + type: list + elements: str location: description: - (Required for new resource) The location or the region in which Database instance exists required: True type: str - key_protect_instance: - description: - - The CRN of Key protect instance - required: False - type: str - whitelist: - description: - - None - required: False - type: list - elements: dict - auto_scaling: + node_disk_allocation_mb: description: - - ICD Auto Scaling + - Disk allocation per node required: False - type: list - elements: dict + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -214,42 +214,42 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), - ('service', 'str'), ('plan', 'str'), + ('service', 'str'), + ('name', 'str'), ('location', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'configuration', + 'node_count', + 'service_endpoints', + 'whitelist', + 'plan', 'version', - 'plan_validation', - 'remote_leader_id', - 'point_in_time_recovery_deployment_id', - 'point_in_time_recovery_time', 'members_disk_allocation_mb', - 'node_count', - 'backup_id', - 'name', + 'node_cpu_allocation_count', + 'point_in_time_recovery_time', + 'users', 'resource_group_id', 'node_memory_allocation_mb', - 'members_memory_allocation_mb', + 'configuration', 'members_cpu_allocation_count', - 'tags', + 'backup_id', + 'remote_leader_id', 'service', - 'plan', + 'members_memory_allocation_mb', + 'auto_scaling', + 'name', + 'key_protect_instance', + 'backup_encryption_key_crn', 'adminpassword', + 'point_in_time_recovery_deployment_id', + 'plan_validation', 'key_protect_key', - 'backup_encryption_key_crn', - 'users', - 'node_disk_allocation_mb', - 'node_cpu_allocation_count', - 'service_endpoints', + 'tags', 'location', - 'key_protect_instance', - 'whitelist', - 'auto_scaling', + 'node_disk_allocation_mb', ] # Params for Data source @@ -258,115 +258,115 @@ ] TL_ALL_PARAMETERS_DS = [ - 'tags', - 'name', - 'location', 'service', + 'name', 'resource_group_id', + 'tags', + 'location', ] TL_CONFLICTS_MAP = { - 'members_disk_allocation_mb': ['node_count', 'node_memory_allocation_mb', 'node_disk_allocation_mb', 'node_cpu_allocation_count'], 'node_count': ['members_memory_allocation_mb', 'members_disk_allocation_mb', 'members_cpu_allocation_count'], + 'members_disk_allocation_mb': ['node_count', 'node_memory_allocation_mb', 'node_disk_allocation_mb', 'node_cpu_allocation_count'], + 'node_cpu_allocation_count': ['members_memory_allocation_mb', 'members_disk_allocation_mb', 'members_cpu_allocation_count'], 'node_memory_allocation_mb': ['members_memory_allocation_mb', 'members_disk_allocation_mb', 'members_cpu_allocation_count'], - 'members_memory_allocation_mb': ['node_count', 'node_memory_allocation_mb', 'node_disk_allocation_mb', 'node_cpu_allocation_count'], 'members_cpu_allocation_count': ['node_count', 'node_memory_allocation_mb', 'node_disk_allocation_mb', 'node_cpu_allocation_count'], + 'members_memory_allocation_mb': ['node_count', 'node_memory_allocation_mb', 'node_disk_allocation_mb', 'node_cpu_allocation_count'], 'node_disk_allocation_mb': ['members_memory_allocation_mb', 'members_disk_allocation_mb', 'members_cpu_allocation_count'], - 'node_cpu_allocation_count': ['members_memory_allocation_mb', 'members_disk_allocation_mb', 'members_cpu_allocation_count'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - configuration=dict( + node_count=dict( required=False, - type='str'), - version=dict( + type='int'), + service_endpoints=dict( required=False, type='str'), - plan_validation=dict( - required=False, - type='bool'), - remote_leader_id=dict( + whitelist=dict( required=False, - type='str'), - point_in_time_recovery_deployment_id=dict( + elements='', + type='list'), + plan=dict( required=False, type='str'), - point_in_time_recovery_time=dict( + version=dict( required=False, type='str'), members_disk_allocation_mb=dict( required=False, type='int'), - node_count=dict( + node_cpu_allocation_count=dict( required=False, type='int'), - backup_id=dict( + point_in_time_recovery_time=dict( required=False, type='str'), - name=dict( + users=dict( required=False, - type='str'), + elements='', + type='list'), resource_group_id=dict( required=False, type='str'), node_memory_allocation_mb=dict( required=False, type='int'), - members_memory_allocation_mb=dict( + configuration=dict( required=False, - type='int'), + type='str'), members_cpu_allocation_count=dict( required=False, type='int'), - tags=dict( - required=False, - elements='', - type='list'), - service=dict( - required=False, - type='str'), - plan=dict( + backup_id=dict( required=False, type='str'), - adminpassword=dict( + remote_leader_id=dict( required=False, type='str'), - key_protect_key=dict( + service=dict( required=False, type='str'), - backup_encryption_key_crn=dict( + members_memory_allocation_mb=dict( required=False, - type='str'), - users=dict( + type='int'), + auto_scaling=dict( required=False, elements='', type='list'), - node_disk_allocation_mb=dict( + name=dict( required=False, - type='int'), - node_cpu_allocation_count=dict( + type='str'), + key_protect_instance=dict( required=False, - type='int'), - service_endpoints=dict( + type='str'), + backup_encryption_key_crn=dict( required=False, type='str'), - location=dict( + adminpassword=dict( required=False, type='str'), - key_protect_instance=dict( + point_in_time_recovery_deployment_id=dict( required=False, type='str'), - whitelist=dict( + plan_validation=dict( required=False, - elements='', - type='list'), - auto_scaling=dict( + type='bool'), + key_protect_key=dict( + required=False, + type='str'), + tags=dict( required=False, elements='', type='list'), + location=dict( + required=False, + type='str'), + node_disk_allocation_mb=dict( + required=False, + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_database_info.py b/plugins/modules/ibm_database_info.py index 8ec88c9c3..9c037a1eb 100644 --- a/plugins/modules/ibm_database_info.py +++ b/plugins/modules/ibm_database_info.py @@ -21,30 +21,30 @@ - Terraform v0.12.20 options: - tags: + service: description: - - None + - The name of the Cloud Database service required: False - type: list - elements: str + type: str name: description: - Resource instance name for example, my Database instance required: True type: str - location: + resource_group_id: description: - - The location or the region in which the Database instance exists + - The id of the resource group in which the Database instance is present required: False type: str - service: + tags: description: - - The name of the Cloud Database service + - None required: False - type: str - resource_group_id: + type: list + elements: str + location: description: - - The id of the resource group in which the Database instance is present + - The location or the region in which the Database instance exists required: False type: str iaas_classic_username: @@ -85,11 +85,11 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'tags', - 'name', - 'location', 'service', + 'name', 'resource_group_id', + 'tags', + 'location', ] @@ -100,20 +100,20 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - tags=dict( + service=dict( required=False, - elements='', - type='list'), + type='str'), name=dict( required=True, type='str'), - location=dict( + resource_group_id=dict( required=False, type='str'), - service=dict( + tags=dict( required=False, - type='str'), - resource_group_id=dict( + elements='', + type='list'), + location=dict( required=False, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_dl_gateway.py b/plugins/modules/ibm_dl_gateway.py index ffbd52573..9d4698d6b 100644 --- a/plugins/modules/ibm_dl_gateway.py +++ b/plugins/modules/ibm_dl_gateway.py @@ -22,29 +22,34 @@ - Terraform v0.12.20 options: - loa_reject_reason: + bfd_status: description: - - Loa reject reason + - Gateway BFD status required: False type: str - bfd_status_updated_at: + bgp_ibm_cidr: description: - - Date and time BFD status was updated + - BGP IBM CIDR required: False type: str - port: + resource_group: description: - - Gateway port + - Gateway resource group required: False type: str - name: + authentication_key: description: - - (Required for new resource) The unique user-defined name for this gateway - required: True + - BGP MD5 authentication key + required: False type: str - connection_mode: + bgp_base_cidr: description: - - Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection + - BGP base CIDR + required: False + type: str + port: + description: + - Gateway port required: False type: str metered: @@ -52,98 +57,93 @@ - (Required for new resource) Metered billing option required: True type: bool - macsec_config: - description: - - MACsec configuration information - required: False - type: list - elements: dict - bgp_ibm_cidr: + carrier_name: description: - - BGP IBM CIDR + - Carrier name required: False type: str + global_: + description: + - (Required for new resource) Gateways with global routing (true) can connect to networks outside their associated region + required: True + type: bool bfd_interval: description: - BFD Interval required: False type: int - bfd_status: - description: - - Gateway BFD status - required: False - type: str - customer_name: + speed_mbps: description: - - Customer name - required: False - type: str + - (Required for new resource) Gateway speed in megabits per second + required: True + type: int bgp_cer_cidr: description: - BGP customer edge router CIDR required: False type: str - bgp_asn: - description: - - (Required for new resource) BGP ASN - required: True - type: int - location_name: + loa_reject_reason: description: - - Gateway location + - Loa reject reason required: False type: str - authentication_key: + bfd_multiplier: description: - - BGP MD5 authentication key + - BFD Multiplier required: False - type: str - carrier_name: + type: int + customer_name: description: - - Carrier name + - Customer name required: False type: str - global_: - description: - - (Required for new resource) Gateways with global routing (true) can connect to networks outside their associated region - required: True - type: bool - speed_mbps: + bgp_asn: description: - - (Required for new resource) Gateway speed in megabits per second + - (Required for new resource) BGP ASN required: True type: int + connection_mode: + description: + - Type of services this Gateway is attached to. Mode transit means this Gateway will be attached to Transit Gateway Service and direct means this Gateway will be attached to vpc or classic connection + required: False + type: str type: description: - (Required for new resource) Gateway type required: True type: str - resource_group: + name: description: - - Gateway resource group - required: False + - (Required for new resource) The unique user-defined name for this gateway + required: True type: str - bfd_multiplier: + macsec_config: description: - - BFD Multiplier + - MACsec configuration information required: False - type: int - cross_connect_router: + type: list + elements: dict + tags: description: - - Cross connect router + - Tags for the direct link gateway + required: False + type: list + elements: str + bfd_status_updated_at: + description: + - Date and time BFD status was updated required: False type: str - bgp_base_cidr: + cross_connect_router: description: - - BGP base CIDR + - Cross connect router required: False type: str - tags: + location_name: description: - - Tags for the direct link gateway + - Gateway location required: False - type: list - elements: str + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -190,40 +190,40 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('metered', 'bool'), - ('bgp_asn', 'int'), ('global_', 'bool'), ('speed_mbps', 'int'), + ('bgp_asn', 'int'), ('type', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'loa_reject_reason', - 'bfd_status_updated_at', - 'port', - 'name', - 'connection_mode', - 'metered', - 'macsec_config', - 'bgp_ibm_cidr', - 'bfd_interval', 'bfd_status', - 'customer_name', - 'bgp_cer_cidr', - 'bgp_asn', - 'location_name', + 'bgp_ibm_cidr', + 'resource_group', 'authentication_key', + 'bgp_base_cidr', + 'port', + 'metered', 'carrier_name', 'global_', + 'bfd_interval', 'speed_mbps', - 'type', - 'resource_group', + 'bgp_cer_cidr', + 'loa_reject_reason', 'bfd_multiplier', - 'cross_connect_router', - 'bgp_base_cidr', + 'customer_name', + 'bgp_asn', + 'connection_mode', + 'type', + 'name', + 'macsec_config', 'tags', + 'bfd_status_updated_at', + 'cross_connect_router', + 'location_name', ] # Params for Data source @@ -243,80 +243,80 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - loa_reject_reason=dict( + bfd_status=dict( required=False, type='str'), - bfd_status_updated_at=dict( + bgp_ibm_cidr=dict( required=False, type='str'), - port=dict( + resource_group=dict( required=False, type='str'), - name=dict( + authentication_key=dict( required=False, type='str'), - connection_mode=dict( + bgp_base_cidr=dict( + required=False, + type='str'), + port=dict( required=False, type='str'), metered=dict( required=False, type='bool'), - macsec_config=dict( - required=False, - elements='', - type='list'), - bgp_ibm_cidr=dict( + carrier_name=dict( required=False, type='str'), + global_=dict( + required=False, + type='bool'), bfd_interval=dict( required=False, type='int'), - bfd_status=dict( + speed_mbps=dict( + required=False, + type='int'), + bgp_cer_cidr=dict( required=False, type='str'), - customer_name=dict( + loa_reject_reason=dict( required=False, type='str'), - bgp_cer_cidr=dict( + bfd_multiplier=dict( + required=False, + type='int'), + customer_name=dict( required=False, type='str'), bgp_asn=dict( required=False, type='int'), - location_name=dict( + connection_mode=dict( required=False, type='str'), - authentication_key=dict( + type=dict( required=False, type='str'), - carrier_name=dict( + name=dict( required=False, type='str'), - global_=dict( - required=False, - type='bool'), - speed_mbps=dict( + macsec_config=dict( required=False, - type='int'), - type=dict( + elements='', + type='list'), + tags=dict( required=False, - type='str'), - resource_group=dict( + elements='', + type='list'), + bfd_status_updated_at=dict( required=False, type='str'), - bfd_multiplier=dict( - required=False, - type='int'), cross_connect_router=dict( required=False, type='str'), - bgp_base_cidr=dict( + location_name=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dl_provider_gateway.py b/plugins/modules/ibm_dl_provider_gateway.py index afe10b0ba..e9c622dc1 100644 --- a/plugins/modules/ibm_dl_provider_gateway.py +++ b/plugins/modules/ibm_dl_provider_gateway.py @@ -22,47 +22,47 @@ - Terraform v0.12.20 options: - bgp_asn: - description: - - (Required for new resource) BGP ASN - required: True - type: int port: description: - (Required for new resource) Gateway port required: True type: str - speed_mbps: + name: description: - - (Required for new resource) Gateway speed in megabits per second + - (Required for new resource) The unique user-defined name for this gateway required: True - type: int - bgp_ibm_cidr: - description: - - BGP IBM CIDR - required: False type: str - bgp_cer_cidr: + tags: description: - - BGP customer edge router CIDR + - Tags for the direct link gateway required: False - type: str - name: + type: list + elements: str + bgp_ibm_cidr: description: - - (Required for new resource) The unique user-defined name for this gateway - required: True + - BGP IBM CIDR + required: False type: str customer_account_id: description: - (Required for new resource) Customer IBM Cloud account ID for the new gateway. A gateway object containing the pending create request will become available in the specified account. required: True type: str - tags: + speed_mbps: description: - - Tags for the direct link gateway + - (Required for new resource) Gateway speed in megabits per second + required: True + type: int + bgp_cer_cidr: + description: + - BGP customer edge router CIDR required: False - type: list - elements: str + type: str + bgp_asn: + description: + - (Required for new resource) BGP ASN + required: True + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -109,23 +109,23 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('bgp_asn', 'int'), ('port', 'str'), - ('speed_mbps', 'int'), ('name', 'str'), ('customer_account_id', 'str'), + ('speed_mbps', 'int'), + ('bgp_asn', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'bgp_asn', 'port', - 'speed_mbps', - 'bgp_ibm_cidr', - 'bgp_cer_cidr', 'name', - 'customer_account_id', 'tags', + 'bgp_ibm_cidr', + 'customer_account_id', + 'speed_mbps', + 'bgp_cer_cidr', + 'bgp_asn', ] # Params for Data source @@ -142,31 +142,31 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - bgp_asn=dict( - required=False, - type='int'), port=dict( required=False, type='str'), - speed_mbps=dict( + name=dict( required=False, - type='int'), + type='str'), + tags=dict( + required=False, + elements='', + type='list'), bgp_ibm_cidr=dict( required=False, type='str'), - bgp_cer_cidr=dict( + customer_account_id=dict( required=False, type='str'), - name=dict( + speed_mbps=dict( required=False, - type='str'), - customer_account_id=dict( + type='int'), + bgp_cer_cidr=dict( required=False, type='str'), - tags=dict( + bgp_asn=dict( required=False, - elements='', - type='list'), + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dl_virtual_connection.py b/plugins/modules/ibm_dl_virtual_connection.py index db8b7bc17..e84223fba 100644 --- a/plugins/modules/ibm_dl_virtual_connection.py +++ b/plugins/modules/ibm_dl_virtual_connection.py @@ -22,19 +22,14 @@ - Terraform v0.12.20 options: - name: - description: - - (Required for new resource) The user-defined name for this virtual connection. Virtualconnection names are unique within a gateway. This is the name of thevirtual connection itself, the network being connected may have its ownname attribute - required: True - type: str gateway: description: - (Required for new resource) The Direct Link gateway identifier required: True type: str - type: + name: description: - - (Required for new resource) The type of virtual connection.Allowable values (classic,vpc) + - (Required for new resource) The user-defined name for this virtual connection. Virtualconnection names are unique within a gateway. This is the name of thevirtual connection itself, the network being connected may have its ownname attribute required: True type: str network_id: @@ -42,6 +37,11 @@ - Unique identifier of the target network. For type=vpc virtual connections this is the CRN of the target VPC. This field does not apply to type=classic connections. required: False type: str + type: + description: + - (Required for new resource) The type of virtual connection.Allowable values (classic,vpc) + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -88,17 +88,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('gateway', 'str'), + ('name', 'str'), ('type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'gateway', - 'type', + 'name', 'network_id', + 'type', ] # Params for Data source @@ -115,18 +115,18 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=False, - type='str'), gateway=dict( required=False, type='str'), - type=dict( + name=dict( required=False, type='str'), network_id=dict( required=False, type='str'), + type=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_custom_resolver.py b/plugins/modules/ibm_dns_custom_resolver.py index 8169c6fcd..20f859245 100644 --- a/plugins/modules/ibm_dns_custom_resolver.py +++ b/plugins/modules/ibm_dns_custom_resolver.py @@ -22,39 +22,39 @@ - Terraform v0.12.20 options: - locations: + name: description: - - Locations on which the custom resolver will be running + - (Required for new resource) Name of the custom resolver + required: True + type: str + description: + description: + - Descriptive text of the custom resolver. required: False - type: list - elements: dict + type: str instance_id: description: - (Required for new resource) Instance ID required: True type: str - name: - description: - - (Required for new resource) Name of the custom resolver - required: True - type: str enabled: description: - Whether the custom resolver is enabled required: False type: bool default: True - description: - description: - - Descriptive text of the custom resolver. - required: False - type: str high_availability: description: - Whether High Availability is enabled in custom resolver required: False type: bool default: True + locations: + description: + - Locations on which the custom resolver will be running + required: False + type: list + elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -101,18 +101,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('instance_id', 'str'), ('name', 'str'), + ('instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'locations', - 'instance_id', 'name', - 'enabled', 'description', + 'instance_id', + 'enabled', 'high_availability', + 'locations', ] # Params for Data source @@ -129,25 +129,25 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - locations=dict( + name=dict( required=False, - elements='', - type='list'), - instance_id=dict( + type='str'), + description=dict( required=False, type='str'), - name=dict( + instance_id=dict( required=False, type='str'), enabled=dict( required=False, type='bool'), - description=dict( - required=False, - type='str'), high_availability=dict( required=False, type='bool'), + locations=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_custom_resolver_forwarding_rule.py b/plugins/modules/ibm_dns_custom_resolver_forwarding_rule.py index 51c983a94..1e9bc3d96 100644 --- a/plugins/modules/ibm_dns_custom_resolver_forwarding_rule.py +++ b/plugins/modules/ibm_dns_custom_resolver_forwarding_rule.py @@ -22,16 +22,6 @@ - Terraform v0.12.20 options: - type: - description: - - Type of the forwarding rule. - required: False - type: str - match: - description: - - The matching zone or hostname. - required: False - type: str forward_to: description: - The upstream DNS servers will be forwarded to. @@ -53,6 +43,16 @@ - Descriptive text of the forwarding rule. required: False type: str + type: + description: + - Type of the forwarding rule. + required: False + type: str + match: + description: + - The matching zone or hostname. + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -105,12 +105,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'type', - 'match', 'forward_to', 'instance_id', 'resolver_id', 'description', + 'type', + 'match', ] # Params for Data source @@ -127,12 +127,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - type=dict( - required=False, - type='str'), - match=dict( - required=False, - type='str'), forward_to=dict( required=False, elements='', @@ -146,6 +140,12 @@ description=dict( required=False, type='str'), + type=dict( + required=False, + type='str'), + match=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_custom_resolver_location.py b/plugins/modules/ibm_dns_custom_resolver_location.py index 7b66254dd..8998e260e 100644 --- a/plugins/modules/ibm_dns_custom_resolver_location.py +++ b/plugins/modules/ibm_dns_custom_resolver_location.py @@ -22,6 +22,12 @@ - Terraform v0.12.20 options: + cr_enabled: + description: + - None + required: False + type: bool + default: True instance_id: description: - (Required for new resource) Instance ID @@ -43,12 +49,6 @@ required: False type: bool default: False - cr_enabled: - description: - - None - required: False - type: bool - default: True id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -102,11 +102,11 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'cr_enabled', 'instance_id', 'resolver_id', 'subnet_crn', 'enabled', - 'cr_enabled', ] # Params for Data source @@ -123,6 +123,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + cr_enabled=dict( + required=False, + type='bool'), instance_id=dict( required=False, type='str'), @@ -135,9 +138,6 @@ enabled=dict( required=False, type='bool'), - cr_enabled=dict( - required=False, - type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_glb.py b/plugins/modules/ibm_dns_glb.py index 3a9712a0e..4745c466c 100644 --- a/plugins/modules/ibm_dns_glb.py +++ b/plugins/modules/ibm_dns_glb.py @@ -22,12 +22,16 @@ - Terraform v0.12.20 options: - ttl: + description: description: - - Time to live in second + - Descriptive text of the load balancer required: False - type: int - default: 60 + type: str + fallback_pool: + description: + - (Required for new resource) The pool ID to use when all other pools are detected as unhealthy + required: True + type: str default_pools: description: - (Required for new resource) A list of pool IDs ordered by their failover priority @@ -40,11 +44,22 @@ required: False type: list elements: dict - fallback_pool: + name: description: - - (Required for new resource) The pool ID to use when all other pools are detected as unhealthy + - (Required for new resource) Name of the load balancer required: True type: str + enabled: + description: + - Whether the load balancer is enabled + required: False + type: bool + ttl: + description: + - Time to live in second + required: False + type: int + default: 60 instance_id: description: - (Required for new resource) The GUID of the private DNS. @@ -55,21 +70,6 @@ - (Required for new resource) Zone Id required: True type: str - name: - description: - - (Required for new resource) Name of the load balancer - required: True - type: str - description: - description: - - Descriptive text of the load balancer - required: False - type: str - enabled: - description: - - Whether the load balancer is enabled - required: False - type: bool id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -116,24 +116,24 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('default_pools', 'list'), ('fallback_pool', 'str'), + ('default_pools', 'list'), + ('name', 'str'), ('instance_id', 'str'), ('zone_id', 'str'), - ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'ttl', + 'description', + 'fallback_pool', 'default_pools', 'az_pools', - 'fallback_pool', - 'instance_id', - 'zone_id', 'name', - 'description', 'enabled', + 'ttl', + 'instance_id', + 'zone_id', ] # Params for Data source @@ -150,9 +150,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - ttl=dict( + description=dict( required=False, - type='int'), + type='str'), + fallback_pool=dict( + required=False, + type='str'), default_pools=dict( required=False, elements='', @@ -161,24 +164,21 @@ required=False, elements='', type='list'), - fallback_pool=dict( + name=dict( required=False, type='str'), - instance_id=dict( + enabled=dict( required=False, - type='str'), - zone_id=dict( + type='bool'), + ttl=dict( required=False, - type='str'), - name=dict( + type='int'), + instance_id=dict( required=False, type='str'), - description=dict( + zone_id=dict( required=False, type='str'), - enabled=dict( - required=False, - type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_glb_monitor.py b/plugins/modules/ibm_dns_glb_monitor.py index 853225e94..aa9b2905f 100644 --- a/plugins/modules/ibm_dns_glb_monitor.py +++ b/plugins/modules/ibm_dns_glb_monitor.py @@ -22,36 +22,31 @@ - Terraform v0.12.20 options: - interval: + name: description: - - The interval between each health check - required: False - type: int - default: 60 - method: + - (Required for new resource) The unique identifier of a service instance. + required: True + type: str + description: description: - - The method to use for the health check + - Descriptive text of the load balancer monitor required: False type: str - headers: + interval: description: - - The HTTP request headers to send in the health check + - The interval between each health check required: False - type: list - elements: dict - expected_body: + type: int + default: 60 + retries: description: - - A case-insensitive sub-string to look for in the response body + - The number of retries to attempt in case of a timeout before marking the origin as unhealthy required: False - type: str - name: - description: - - (Required for new resource) The unique identifier of a service instance. - required: True - type: str - description: + type: int + default: 1 + method: description: - - Descriptive text of the load balancer monitor + - The method to use for the health check required: False type: str port: @@ -64,23 +59,23 @@ - The endpoint path to health check against required: False type: str - instance_id: + headers: description: - - (Required for new resource) Instance Id - required: True - type: str + - The HTTP request headers to send in the health check + required: False + type: list + elements: dict type: description: - The protocol to use for the health check required: False type: str default: HTTP - retries: + instance_id: description: - - The number of retries to attempt in case of a timeout before marking the origin as unhealthy - required: False - type: int - default: 1 + - (Required for new resource) Instance Id + required: True + type: str timeout: description: - The timeout (in seconds) before marking the health check as failed @@ -97,6 +92,11 @@ - The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS required: False type: str + expected_body: + description: + - A case-insensitive sub-string to look for in the response body + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -149,20 +149,20 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'interval', - 'method', - 'headers', - 'expected_body', 'name', 'description', + 'interval', + 'retries', + 'method', 'port', 'path', - 'instance_id', + 'headers', 'type', - 'retries', + 'instance_id', 'timeout', 'allow_insecure', 'expected_codes', + 'expected_body', ] # Params for Data source @@ -179,23 +179,19 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - interval=dict( - required=False, - type='int'), - method=dict( + name=dict( required=False, type='str'), - headers=dict( - required=False, - elements='', - type='list'), - expected_body=dict( + description=dict( required=False, type='str'), - name=dict( + interval=dict( required=False, - type='str'), - description=dict( + type='int'), + retries=dict( + required=False, + type='int'), + method=dict( required=False, type='str'), port=dict( @@ -204,15 +200,16 @@ path=dict( required=False, type='str'), - instance_id=dict( + headers=dict( required=False, - type='str'), + elements='', + type='list'), type=dict( required=False, type='str'), - retries=dict( + instance_id=dict( required=False, - type='int'), + type='str'), timeout=dict( required=False, type='int'), @@ -222,6 +219,9 @@ expected_codes=dict( required=False, type='str'), + expected_body=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_glb_pool.py b/plugins/modules/ibm_dns_glb_pool.py index fc7357cf4..25f9bd169 100644 --- a/plugins/modules/ibm_dns_glb_pool.py +++ b/plugins/modules/ibm_dns_glb_pool.py @@ -22,46 +22,45 @@ - Terraform v0.12.20 options: - monitor: + instance_id: description: - - The ID of the load balancer monitor to be associated to this pool - required: False + - (Required for new resource) Instance Id + required: True type: str - healthcheck_subnets: + healthy_origins_threshold: description: - - Health check subnet crn of VSIs + - The minimum number of origins that must be healthy for this pool to serve traffic required: False - type: list - elements: str - instance_id: + type: int + healthcheck_region: description: - - (Required for new resource) Instance Id - required: True + - Health check region of VSIs + required: False type: str name: description: - (Required for new resource) The unique identifier of a service instance. required: True type: str - origins: - description: - - (Required for new resource) Origins info - required: True - type: list - elements: dict - notification_channel: + description: description: - - The notification channel,It is a webhook url + - Descriptive text of the load balancer pool required: False type: str - healthcheck_region: + healthcheck_subnets: description: - - Health check region of VSIs + - Health check subnet crn of VSIs + required: False + type: list + elements: str + monitor: + description: + - The ID of the load balancer monitor to be associated to this pool required: False type: str - description: + notification_channel: description: - - Descriptive text of the load balancer pool + - The notification channel,It is a webhook url required: False type: str enabled: @@ -69,11 +68,12 @@ - Whether the load balancer pool is enabled required: False type: bool - healthy_origins_threshold: + origins: description: - - The minimum number of origins that must be healthy for this pool to serve traffic - required: False - type: int + - (Required for new resource) Origins info + required: True + type: list + elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -127,16 +127,16 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'monitor', - 'healthcheck_subnets', 'instance_id', - 'name', - 'origins', - 'notification_channel', + 'healthy_origins_threshold', 'healthcheck_region', + 'name', 'description', + 'healthcheck_subnets', + 'monitor', + 'notification_channel', 'enabled', - 'healthy_origins_threshold', + 'origins', ] # Params for Data source @@ -153,38 +153,38 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - monitor=dict( + instance_id=dict( required=False, type='str'), - healthcheck_subnets=dict( + healthy_origins_threshold=dict( required=False, - elements='', - type='list'), - instance_id=dict( + type='int'), + healthcheck_region=dict( required=False, type='str'), name=dict( required=False, type='str'), - origins=dict( + description=dict( + required=False, + type='str'), + healthcheck_subnets=dict( required=False, elements='', type='list'), - notification_channel=dict( - required=False, - type='str'), - healthcheck_region=dict( + monitor=dict( required=False, type='str'), - description=dict( + notification_channel=dict( required=False, type='str'), enabled=dict( required=False, type='bool'), - healthy_origins_threshold=dict( + origins=dict( required=False, - type='int'), + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_record.py b/plugins/modules/ibm_dns_record.py index 973727f9e..86f6047f8 100644 --- a/plugins/modules/ibm_dns_record.py +++ b/plugins/modules/ibm_dns_record.py @@ -22,52 +22,40 @@ - Terraform v0.12.20 options: + data: + description: + - (Required for new resource) DNS record data + required: True + type: str expire: description: - DNS record expiry info required: False type: int - mx_priority: + responsible_person: description: - - Maximum priority + - Responsible person for DNS record required: False - type: int - default: 0 - port: + type: str + retry: description: - - port number + - Retry count required: False type: int + service: + description: + - service info + required: False + type: str priority: description: - priority info required: False type: int default: 0 - tags: - description: - - tags set for the resource - required: False - type: list - elements: str - protocol: - description: - - protocol info - required: False - type: str - domain_id: - description: - - (Required for new resource) Domain ID of dns record instance - required: True - type: int - host: - description: - - (Required for new resource) Hostname - required: True - type: str - retry: + refresh: description: - - Retry count + - refresh rate required: False type: int ttl: @@ -75,42 +63,54 @@ - (Required for new resource) TTL configuration required: True type: int - type: + protocol: description: - - (Required for new resource) DNS record type - required: True + - protocol info + required: False type: str - data: + domain_id: description: - - (Required for new resource) DNS record data + - (Required for new resource) Domain ID of dns record instance required: True - type: str - responsible_person: - description: - - Responsible person for DNS record - required: False - type: str + type: int minimum_ttl: description: - Minimun TTL configuration required: False type: int - service: + port: description: - - service info + - port number required: False - type: str + type: int weight: description: - weight info required: False type: int default: 0 - refresh: + tags: description: - - refresh rate + - tags set for the resource + required: False + type: list + elements: str + host: + description: + - (Required for new resource) Hostname + required: True + type: str + mx_priority: + description: + - Maximum priority required: False type: int + default: 0 + type: + description: + - (Required for new resource) DNS record type + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -157,32 +157,32 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('data', 'str'), + ('ttl', 'int'), ('domain_id', 'int'), ('host', 'str'), - ('ttl', 'int'), ('type', 'str'), - ('data', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'data', 'expire', - 'mx_priority', - 'port', + 'responsible_person', + 'retry', + 'service', 'priority', - 'tags', + 'refresh', + 'ttl', 'protocol', 'domain_id', - 'host', - 'retry', - 'ttl', - 'type', - 'data', - 'responsible_person', 'minimum_ttl', - 'service', + 'port', 'weight', - 'refresh', + 'tags', + 'host', + 'mx_priority', + 'type', ] # Params for Data source @@ -199,58 +199,58 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + data=dict( + required=False, + type='str'), expire=dict( required=False, type='int'), - mx_priority=dict( + responsible_person=dict( required=False, - type='int'), - port=dict( + type='str'), + retry=dict( required=False, type='int'), + service=dict( + required=False, + type='str'), priority=dict( required=False, type='int'), - tags=dict( + refresh=dict( required=False, - elements='', - type='list'), + type='int'), + ttl=dict( + required=False, + type='int'), protocol=dict( required=False, type='str'), domain_id=dict( required=False, type='int'), - host=dict( - required=False, - type='str'), - retry=dict( + minimum_ttl=dict( required=False, type='int'), - ttl=dict( + port=dict( required=False, type='int'), - type=dict( + weight=dict( required=False, - type='str'), - data=dict( + type='int'), + tags=dict( required=False, - type='str'), - responsible_person=dict( + elements='', + type='list'), + host=dict( required=False, type='str'), - minimum_ttl=dict( + mx_priority=dict( required=False, type='int'), - service=dict( + type=dict( required=False, type='str'), - weight=dict( - required=False, - type='int'), - refresh=dict( - required=False, - type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_resource_record.py b/plugins/modules/ibm_dns_resource_record.py index 52805cdac..8c3fc44c0 100644 --- a/plugins/modules/ibm_dns_resource_record.py +++ b/plugins/modules/ibm_dns_resource_record.py @@ -22,35 +22,35 @@ - Terraform v0.12.20 options: - zone_id: + ttl: description: - - (Required for new resource) Zone ID - required: True - type: str + - DNS record TTL + required: False + type: int + default: 900 port: description: - DNS server Port required: False type: int - type: - description: - - (Required for new resource) DNS record Type - required: True - type: str service: description: - Service info required: False type: str - priority: + protocol: description: - - DNS server Priority + - Protocol required: False - type: int - default: 0 - instance_id: + type: str + name: description: - - (Required for new resource) Instance ID + - (Required for new resource) DNS record name + required: True + type: str + type: + description: + - (Required for new resource) DNS record Type required: True type: str preference: @@ -59,33 +59,33 @@ required: False type: int default: 0 - weight: + priority: description: - - DNS server weight + - DNS server Priority required: False type: int default: 0 - protocol: - description: - - Protocol - required: False - type: str - name: - description: - - (Required for new resource) DNS record name - required: True - type: str rdata: description: - (Required for new resource) DNS record Data required: True type: str - ttl: + weight: description: - - DNS record TTL + - DNS server weight required: False type: int - default: 900 + default: 0 + instance_id: + description: + - (Required for new resource) Instance ID + required: True + type: str + zone_id: + description: + - (Required for new resource) Zone ID + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -132,27 +132,27 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('zone_id', 'str'), - ('type', 'str'), - ('instance_id', 'str'), ('name', 'str'), + ('type', 'str'), ('rdata', 'str'), + ('instance_id', 'str'), + ('zone_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'zone_id', + 'ttl', 'port', - 'type', 'service', - 'priority', - 'instance_id', - 'preference', - 'weight', 'protocol', 'name', + 'type', + 'preference', + 'priority', 'rdata', - 'ttl', + 'weight', + 'instance_id', + 'zone_id', ] # Params for Data source @@ -169,42 +169,42 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - zone_id=dict( + ttl=dict( required=False, - type='str'), + type='int'), port=dict( required=False, type='int'), - type=dict( + service=dict( required=False, type='str'), - service=dict( + protocol=dict( required=False, type='str'), - priority=dict( + name=dict( required=False, - type='int'), - instance_id=dict( + type='str'), + type=dict( required=False, type='str'), preference=dict( required=False, type='int'), - weight=dict( + priority=dict( required=False, type='int'), - protocol=dict( + rdata=dict( required=False, type='str'), - name=dict( + weight=dict( required=False, - type='str'), - rdata=dict( + type='int'), + instance_id=dict( required=False, type='str'), - ttl=dict( + zone_id=dict( required=False, - type='int'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_secondary.py b/plugins/modules/ibm_dns_secondary.py index 5621aca72..57e043b5d 100644 --- a/plugins/modules/ibm_dns_secondary.py +++ b/plugins/modules/ibm_dns_secondary.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - master_ip_address: - description: - - (Required for new resource) Master IP Address - required: True - type: str transfer_frequency: description: - (Required for new resource) Transfer frequency value @@ -43,6 +38,11 @@ required: False type: list elements: str + master_ip_address: + description: + - (Required for new resource) Master IP Address + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -89,17 +89,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('master_ip_address', 'str'), ('transfer_frequency', 'int'), ('zone_name', 'str'), + ('master_ip_address', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'master_ip_address', 'transfer_frequency', 'zone_name', 'tags', + 'master_ip_address', ] # Params for Data source @@ -118,9 +118,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - master_ip_address=dict( - required=False, - type='str'), transfer_frequency=dict( required=False, type='int'), @@ -131,6 +128,9 @@ required=False, elements='', type='list'), + master_ip_address=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_dns_zone.py b/plugins/modules/ibm_dns_zone.py index e728fdc8e..3368f8c3e 100644 --- a/plugins/modules/ibm_dns_zone.py +++ b/plugins/modules/ibm_dns_zone.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + name: + description: + - (Required for new resource) Zone name + required: True + type: str description: description: - Zone description @@ -37,11 +42,6 @@ - (Required for new resource) Instance ID required: True type: str - name: - description: - - (Required for new resource) Zone name - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -88,16 +88,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('instance_id', 'str'), ('name', 'str'), + ('instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'name', 'description', 'label', 'instance_id', - 'name', ] # Params for Data source @@ -114,6 +114,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + name=dict( + required=False, + type='str'), description=dict( required=False, type='str'), @@ -123,9 +126,6 @@ instance_id=dict( required=False, type='str'), - name=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_en_destination.py b/plugins/modules/ibm_en_destination.py index 2b5d7474c..f7b30de8d 100644 --- a/plugins/modules/ibm_en_destination.py +++ b/plugins/modules/ibm_en_destination.py @@ -22,9 +22,9 @@ - Terraform v0.12.20 options: - instance_guid: + name: description: - - (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. + - (Required for new resource) The Destintion name. required: True type: str description: @@ -32,9 +32,9 @@ - The Destination description. required: False type: str - name: + instance_guid: description: - - (Required for new resource) The Destintion name. + - (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. required: True type: str type: @@ -94,29 +94,29 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('instance_guid', 'str'), ('name', 'str'), + ('instance_guid', 'str'), ('type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'instance_guid', - 'description', 'name', + 'description', + 'instance_guid', 'type', 'config', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('destination_id', 'str'), ('instance_guid', 'str'), + ('destination_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'destination_id', 'instance_guid', + 'destination_id', ] TL_CONFLICTS_MAP = { @@ -126,13 +126,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance_guid=dict( + name=dict( required=False, type='str'), description=dict( required=False, type='str'), - name=dict( + instance_guid=dict( required=False, type='str'), type=dict( diff --git a/plugins/modules/ibm_en_destination_info.py b/plugins/modules/ibm_en_destination_info.py index b5ba5a32a..3c7ca486f 100644 --- a/plugins/modules/ibm_en_destination_info.py +++ b/plugins/modules/ibm_en_destination_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - destination_id: + instance_guid: description: - - Unique identifier for Destination. + - Unique identifier for IBM Cloud Event Notifications instance. required: True type: str - instance_guid: + destination_id: description: - - Unique identifier for IBM Cloud Event Notifications instance. + - Unique identifier for Destination. required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('destination_id', 'str'), ('instance_guid', 'str'), + ('destination_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'destination_id', 'instance_guid', + 'destination_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - destination_id=dict( + instance_guid=dict( required=True, type='str'), - instance_guid=dict( + destination_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_en_subscription.py b/plugins/modules/ibm_en_subscription.py index 3183968d0..1f0b57753 100644 --- a/plugins/modules/ibm_en_subscription.py +++ b/plugins/modules/ibm_en_subscription.py @@ -22,9 +22,9 @@ - Terraform v0.12.20 options: - name: + instance_guid: description: - - (Required for new resource) Subscription name. + - (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. required: True type: str description: @@ -32,9 +32,9 @@ - Subscription description. required: False type: str - topic_id: + destination_id: description: - - (Required for new resource) Topic ID. + - (Required for new resource) Destination ID. required: True type: str attributes: @@ -43,14 +43,14 @@ required: True type: list elements: dict - instance_guid: + name: description: - - (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. + - (Required for new resource) Subscription name. required: True type: str - destination_id: + topic_id: description: - - (Required for new resource) Destination ID. + - (Required for new resource) Topic ID. required: True type: str id: @@ -99,32 +99,32 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), - ('topic_id', 'str'), - ('attributes', 'list'), ('instance_guid', 'str'), ('destination_id', 'str'), + ('attributes', 'list'), + ('name', 'str'), + ('topic_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', - 'description', - 'topic_id', - 'attributes', 'instance_guid', + 'description', 'destination_id', + 'attributes', + 'name', + 'topic_id', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('subscription_id', 'str'), ('instance_guid', 'str'), + ('subscription_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'subscription_id', 'instance_guid', + 'subscription_id', ] TL_CONFLICTS_MAP = { @@ -134,23 +134,23 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + instance_guid=dict( required=False, type='str'), description=dict( required=False, type='str'), - topic_id=dict( + destination_id=dict( required=False, type='str'), attributes=dict( required=False, elements='', type='list'), - instance_guid=dict( + name=dict( required=False, type='str'), - destination_id=dict( + topic_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_en_subscription_info.py b/plugins/modules/ibm_en_subscription_info.py index 58160aa9d..de59986d2 100644 --- a/plugins/modules/ibm_en_subscription_info.py +++ b/plugins/modules/ibm_en_subscription_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - subscription_id: + instance_guid: description: - - Unique identifier for result. + - Unique identifier for IBM Cloud Event Notifications instance. required: True type: str - instance_guid: + subscription_id: description: - - Unique identifier for IBM Cloud Event Notifications instance. + - Unique identifier for result. required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('subscription_id', 'str'), ('instance_guid', 'str'), + ('subscription_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'subscription_id', 'instance_guid', + 'subscription_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - subscription_id=dict( + instance_guid=dict( required=True, type='str'), - instance_guid=dict( + subscription_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_en_topic.py b/plugins/modules/ibm_en_topic.py index 8bc066001..0db7a7627 100644 --- a/plugins/modules/ibm_en_topic.py +++ b/plugins/modules/ibm_en_topic.py @@ -27,6 +27,11 @@ - (Required for new resource) Name of the topic. required: True type: str + description: + description: + - Description of the topic. + required: False + type: str sources: description: - List of sources. @@ -38,11 +43,6 @@ - (Required for new resource) Unique identifier for IBM Cloud Event Notifications instance. required: True type: str - description: - description: - - Description of the topic. - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -96,9 +96,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'name', + 'description', 'sources', 'instance_guid', - 'description', ] # Params for Data source @@ -122,6 +122,9 @@ name=dict( required=False, type='str'), + description=dict( + required=False, + type='str'), sources=dict( required=False, elements='', @@ -129,9 +132,6 @@ instance_guid=dict( required=False, type='str'), - description=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_en_topics_info.py b/plugins/modules/ibm_en_topics_info.py index 79139acb5..8e80a5d16 100644 --- a/plugins/modules/ibm_en_topics_info.py +++ b/plugins/modules/ibm_en_topics_info.py @@ -21,16 +21,16 @@ - Terraform v0.12.20 options: - instance_guid: - description: - - Unique identifier for IBM Cloud Event Notifications instance. - required: True - type: str search_key: description: - Filter the topic by name required: False type: str + instance_guid: + description: + - Unique identifier for IBM Cloud Event Notifications instance. + required: True + type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -69,8 +69,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'instance_guid', 'search_key', + 'instance_guid', ] @@ -81,12 +81,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance_guid=dict( - required=True, - type='str'), search_key=dict( required=False, type='str'), + instance_guid=dict( + required=True, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_enterprise.py b/plugins/modules/ibm_enterprise.py index f8f3e64ae..90fb95764 100644 --- a/plugins/modules/ibm_enterprise.py +++ b/plugins/modules/ibm_enterprise.py @@ -22,26 +22,26 @@ - Terraform v0.12.20 options: - name: + primary_contact_iam_id: description: - - (Required for new resource) The name of the enterprise. This field must have 3 - 60 characters. + - (Required for new resource) The IAM ID of the enterprise primary contact, such as `IBMid-0123ABC`. The IAM ID must already exist. required: True type: str - domain: - description: - - A domain or subdomain for the enterprise, such as `example.com` or `my.example.com`. - required: False - type: str source_account_id: description: - (Required for new resource) The ID of the account that is used to create the enterprise. required: True type: str - primary_contact_iam_id: + name: description: - - (Required for new resource) The IAM ID of the enterprise primary contact, such as `IBMid-0123ABC`. The IAM ID must already exist. + - (Required for new resource) The name of the enterprise. This field must have 3 - 60 characters. required: True type: str + domain: + description: + - A domain or subdomain for the enterprise, such as `example.com` or `my.example.com`. + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -88,17 +88,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), - ('source_account_id', 'str'), ('primary_contact_iam_id', 'str'), + ('source_account_id', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'primary_contact_iam_id', + 'source_account_id', 'name', 'domain', - 'source_account_id', - 'primary_contact_iam_id', ] # Params for Data source @@ -115,16 +115,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + primary_contact_iam_id=dict( required=False, type='str'), - domain=dict( + source_account_id=dict( required=False, type='str'), - source_account_id=dict( + name=dict( required=False, type='str'), - primary_contact_iam_id=dict( + domain=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_enterprise_account.py b/plugins/modules/ibm_enterprise_account.py index 663fee7ec..f7b69fe67 100644 --- a/plugins/modules/ibm_enterprise_account.py +++ b/plugins/modules/ibm_enterprise_account.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - parent: - description: - - (Required for new resource) The CRN of the parent under which the account will be created. The parent can be an existing account group or the enterprise itself. - required: True - type: str owner_iam_id: description: - The IAM ID of the account owner, such as `IBMid-0123ABC`. The IAM ID must already exist. @@ -37,6 +32,16 @@ - The enterprise account ID. required: False type: str + account_id: + description: + - The source account id of account to be imported + required: False + type: str + parent: + description: + - (Required for new resource) The CRN of the parent under which the account will be created. The parent can be an existing account group or the enterprise itself. + required: True + type: str name: description: - The name of the account. This field must have 3 - 60 characters. @@ -47,11 +52,6 @@ - The enterprise ID that the account is a part of. required: False type: str - account_id: - description: - - The source account id of account to be imported - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -103,12 +103,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'parent', 'owner_iam_id', 'enterprise_account_id', + 'account_id', + 'parent', 'name', 'enterprise_id', - 'account_id', ] # Params for Data source @@ -125,22 +125,22 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - parent=dict( - required=False, - type='str'), owner_iam_id=dict( required=False, type='str'), enterprise_account_id=dict( required=False, type='str'), - name=dict( + account_id=dict( required=False, type='str'), - enterprise_id=dict( + parent=dict( required=False, type='str'), - account_id=dict( + name=dict( + required=False, + type='str'), + enterprise_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_enterprise_account_group.py b/plugins/modules/ibm_enterprise_account_group.py index d459aa8b3..fc8bc6162 100644 --- a/plugins/modules/ibm_enterprise_account_group.py +++ b/plugins/modules/ibm_enterprise_account_group.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - name: - description: - - (Required for new resource) The name of the account group. This field must have 3 - 60 characters. - required: True - type: str parent: description: - (Required for new resource) The CRN of the parent under which the account group will be created. The parent can be an existing account group or the enterprise itself. @@ -37,6 +32,11 @@ - (Required for new resource) The IAM ID of the primary contact for this account group, such as `IBMid-0123ABC`. The IAM ID must already exist. required: True type: str + name: + description: + - (Required for new resource) The name of the account group. This field must have 3 - 60 characters. + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -83,16 +83,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('parent', 'str'), ('primary_contact_iam_id', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'parent', 'primary_contact_iam_id', + 'name', ] # Params for Data source @@ -109,15 +109,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=False, - type='str'), parent=dict( required=False, type='str'), primary_contact_iam_id=dict( required=False, type='str'), + name=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_event_streams_schema.py b/plugins/modules/ibm_event_streams_schema.py index ce80d3294..1f79a4b8c 100644 --- a/plugins/modules/ibm_event_streams_schema.py +++ b/plugins/modules/ibm_event_streams_schema.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - resource_instance_id: - description: - - (Required for new resource) The ID or the CRN of the Event Streams service instance - required: True - type: str schema: description: - (Required for new resource) The schema in JSON format @@ -37,6 +32,11 @@ - The ID to be assigned to schema, which must be unique. If this value is not specified, a generated UUID is assigned. required: False type: str + resource_instance_id: + description: + - (Required for new resource) The ID or the CRN of the Event Streams service instance + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -83,26 +83,26 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('resource_instance_id', 'str'), ('schema', 'str'), + ('resource_instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'resource_instance_id', 'schema', 'schema_id', + 'resource_instance_id', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('resource_instance_id', 'str'), ('schema_id', 'str'), + ('resource_instance_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'resource_instance_id', 'schema_id', + 'resource_instance_id', ] TL_CONFLICTS_MAP = { @@ -112,15 +112,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - resource_instance_id=dict( - required=False, - type='str'), schema=dict( required=False, type='str'), schema_id=dict( required=False, type='str'), + resource_instance_id=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_event_streams_schema_info.py b/plugins/modules/ibm_event_streams_schema_info.py index f305c89ef..542f77f93 100644 --- a/plugins/modules/ibm_event_streams_schema_info.py +++ b/plugins/modules/ibm_event_streams_schema_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - resource_instance_id: + schema_id: description: - - The ID or CRN of the Event Streams service instance + - The unique ID to be assigned to the schema. required: True type: str - schema_id: + resource_instance_id: description: - - The unique ID to be assigned to the schema. + - The ID or CRN of the Event Streams service instance required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('resource_instance_id', 'str'), ('schema_id', 'str'), + ('resource_instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'resource_instance_id', 'schema_id', + 'resource_instance_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - resource_instance_id=dict( + schema_id=dict( required=True, type='str'), - schema_id=dict( + resource_instance_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_event_streams_topic.py b/plugins/modules/ibm_event_streams_topic.py index 7b67ebdc1..c706f1abd 100644 --- a/plugins/modules/ibm_event_streams_topic.py +++ b/plugins/modules/ibm_event_streams_topic.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + resource_instance_id: + description: + - (Required for new resource) The CRN of the Event Streams instance + required: True + type: str + name: + description: + - (Required for new resource) The name of the topic + required: True + type: str partitions: description: - The number of partitions @@ -33,16 +43,6 @@ - The configuration parameters of a topic required: False type: dict - resource_instance_id: - description: - - (Required for new resource) The CRN of the Event Streams instance - required: True - type: str - name: - description: - - (Required for new resource) The name of the topic - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -95,21 +95,21 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'partitions', - 'config', 'resource_instance_id', 'name', + 'partitions', + 'config', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('resource_instance_id', 'str'), ('name', 'str'), + ('resource_instance_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'resource_instance_id', 'name', + 'resource_instance_id', ] TL_CONFLICTS_MAP = { @@ -119,18 +119,18 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - partitions=dict( - required=False, - type='int'), - config=dict( - required=False, - type='dict'), resource_instance_id=dict( required=False, type='str'), name=dict( required=False, type='str'), + partitions=dict( + required=False, + type='int'), + config=dict( + required=False, + type='dict'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_event_streams_topic_info.py b/plugins/modules/ibm_event_streams_topic_info.py index 9ecbf0c8f..88619c2e3 100644 --- a/plugins/modules/ibm_event_streams_topic_info.py +++ b/plugins/modules/ibm_event_streams_topic_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - resource_instance_id: + name: description: - - The CRN of the Event Streams instance + - The name of the topic required: True type: str - name: + resource_instance_id: description: - - The name of the topic + - The CRN of the Event Streams instance required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('resource_instance_id', 'str'), ('name', 'str'), + ('resource_instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'resource_instance_id', 'name', + 'resource_instance_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - resource_instance_id=dict( + name=dict( required=True, type='str'), - name=dict( + resource_instance_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_firewall.py b/plugins/modules/ibm_firewall.py index 9ac58c6f5..ebefc8366 100644 --- a/plugins/modules/ibm_firewall.py +++ b/plugins/modules/ibm_firewall.py @@ -22,17 +22,6 @@ - Terraform v0.12.20 options: - public_vlan_id: - description: - - (Required for new resource) Public VLAN ID - required: True - type: int - tags: - description: - - List of tags for the firewall - required: False - type: list - elements: str firewall_type: description: - Firewall type @@ -45,6 +34,17 @@ required: False type: bool default: False + public_vlan_id: + description: + - (Required for new resource) Public VLAN ID + required: True + type: int + tags: + description: + - List of tags for the firewall + required: False + type: list + elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -96,10 +96,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'public_vlan_id', - 'tags', 'firewall_type', 'ha_enabled', + 'public_vlan_id', + 'tags', ] # Params for Data source @@ -116,6 +116,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + firewall_type=dict( + required=False, + type='str'), + ha_enabled=dict( + required=False, + type='bool'), public_vlan_id=dict( required=False, type='int'), @@ -123,12 +129,6 @@ required=False, elements='', type='list'), - firewall_type=dict( - required=False, - type='str'), - ha_enabled=dict( - required=False, - type='bool'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_function_action.py b/plugins/modules/ibm_function_action.py index 0d9e860d7..a9eaa938b 100644 --- a/plugins/modules/ibm_function_action.py +++ b/plugins/modules/ibm_function_action.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + name: + description: + - (Required for new resource) Name of action. + required: True + type: str namespace: description: - (Required for new resource) IBM Cloud function namespace. @@ -38,26 +43,21 @@ - Action visibilty. required: False type: bool - user_defined_annotations: + user_defined_parameters: description: - - Annotation values in KEY VALUE format. + - Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the action. required: False type: str default: [] - name: - description: - - (Required for new resource) Name of action. - required: True - type: str limits: description: - None required: False type: list elements: dict - user_defined_parameters: + user_defined_annotations: description: - - Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the action. + - Annotation values in KEY VALUE format. required: False type: str default: [] @@ -93,31 +93,31 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('name', 'str'), ('namespace', 'str'), ('exec', 'list'), - ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'name', 'namespace', 'exec', 'publish', - 'user_defined_annotations', - 'name', - 'limits', 'user_defined_parameters', + 'limits', + 'user_defined_annotations', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('name', 'str'), ('namespace', 'str'), + ('name', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'name', 'namespace', + 'name', ] TL_CONFLICTS_MAP = { @@ -127,6 +127,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + name=dict( + required=False, + type='str'), namespace=dict( required=False, type='str'), @@ -137,17 +140,14 @@ publish=dict( required=False, type='bool'), - user_defined_annotations=dict( - required=False, - type='str'), - name=dict( + user_defined_parameters=dict( required=False, type='str'), limits=dict( required=False, elements='', type='list'), - user_defined_parameters=dict( + user_defined_annotations=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_function_action_info.py b/plugins/modules/ibm_function_action_info.py index 4b3562b53..b6245967a 100644 --- a/plugins/modules/ibm_function_action_info.py +++ b/plugins/modules/ibm_function_action_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - name: + namespace: description: - - Name of action. + - Name of the namespace. required: True type: str - namespace: + name: description: - - Name of the namespace. + - Name of action. required: True type: str function_namespace: @@ -50,14 +50,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('namespace', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'namespace', + 'name', ] @@ -68,10 +68,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + namespace=dict( required=True, type='str'), - namespace=dict( + name=dict( required=True, type='str'), function_namespace=dict( diff --git a/plugins/modules/ibm_function_package.py b/plugins/modules/ibm_function_package.py index 33e2bd59a..d564767ef 100644 --- a/plugins/modules/ibm_function_package.py +++ b/plugins/modules/ibm_function_package.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + namespace: + description: + - (Required for new resource) IBM Cloud function namespace. + required: True + type: str name: description: - (Required for new resource) Name of package. @@ -33,28 +38,23 @@ required: False type: str default: [] - user_defined_parameters: - description: - - Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the package. - required: False - type: str - default: [] bind_package_name: description: - Name of package to be binded. required: False type: str - namespace: - description: - - (Required for new resource) IBM Cloud function namespace. - required: True - type: str publish: description: - Package visibilty. required: False type: bool default: False + user_defined_parameters: + description: + - Parameters values in KEY VALUE format. Parameter bindings included in the context passed to the package. + required: False + type: str + default: [] id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -87,18 +87,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('namespace', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'namespace', 'name', 'user_defined_annotations', - 'user_defined_parameters', 'bind_package_name', - 'namespace', 'publish', + 'user_defined_parameters', ] # Params for Data source @@ -119,24 +119,24 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + namespace=dict( required=False, type='str'), - user_defined_annotations=dict( + name=dict( required=False, type='str'), - user_defined_parameters=dict( + user_defined_annotations=dict( required=False, type='str'), bind_package_name=dict( required=False, type='str'), - namespace=dict( - required=False, - type='str'), publish=dict( required=False, type='bool'), + user_defined_parameters=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_function_rule.py b/plugins/modules/ibm_function_rule.py index 7394c4a8e..4e4982529 100644 --- a/plugins/modules/ibm_function_rule.py +++ b/plugins/modules/ibm_function_rule.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - action_name: - description: - - (Required for new resource) Name of action. - required: True - type: str namespace: description: - (Required for new resource) IBM Cloud function namespace. @@ -42,6 +37,11 @@ - (Required for new resource) Name of trigger. required: True type: str + action_name: + description: + - (Required for new resource) Name of action. + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -74,18 +74,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('action_name', 'str'), ('namespace', 'str'), ('name', 'str'), ('trigger_name', 'str'), + ('action_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'action_name', 'namespace', 'name', 'trigger_name', + 'action_name', ] # Params for Data source @@ -106,9 +106,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - action_name=dict( - required=False, - type='str'), namespace=dict( required=False, type='str'), @@ -118,6 +115,9 @@ trigger_name=dict( required=False, type='str'), + action_name=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_hardware_firewall_shared.py b/plugins/modules/ibm_hardware_firewall_shared.py index ee47cb584..9bd10a64f 100644 --- a/plugins/modules/ibm_hardware_firewall_shared.py +++ b/plugins/modules/ibm_hardware_firewall_shared.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - firewall_type: - description: - - (Required for new resource) Firewall type - required: True - type: str virtual_instance_id: description: - Virtual instance ID @@ -37,6 +32,11 @@ - Hardware instance ID required: False type: int + firewall_type: + description: + - (Required for new resource) Firewall type + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -88,9 +88,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'firewall_type', 'virtual_instance_id', 'hardware_instance_id', + 'firewall_type', ] # Params for Data source @@ -109,15 +109,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - firewall_type=dict( - required=False, - type='str'), virtual_instance_id=dict( required=False, type='int'), hardware_instance_id=dict( required=False, type='int'), + firewall_type=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_hpcs.py b/plugins/modules/ibm_hpcs.py index dc1e9807b..5287ff17a 100644 --- a/plugins/modules/ibm_hpcs.py +++ b/plugins/modules/ibm_hpcs.py @@ -27,68 +27,68 @@ - The number of failover crypto units for your service instance required: False type: int - admins: + service: description: - - (Required for new resource) Crypto Unit Administrators - required: True - type: list - elements: dict - revocation_threshold: + - The name of the service offering `hs-crypto` + required: False + type: str + default: hs-crypto + signature_threshold: description: - - (Required for new resource) Revocation Threshold Value + - (Required for new resource) Signature Threshold Value required: True type: int - location: + tags: description: - - (Required for new resource) The location where the HPCS instance available - required: True + - None + required: False + type: list + elements: str + resource_group_id: + description: + - The resource group id + required: False type: str units: description: - (Required for new resource) The number of operational crypto units for your service instance required: True type: int - resource_group_id: + signature_server_url: description: - - The resource group id + - URL of signing service required: False type: str - name: + plan: description: - - (Required for new resource) A name for the HPCS instance + - (Required for new resource) The plan type of the HPCS Instance required: True type: str - tags: - description: - - None - required: False - type: list - elements: str - signature_threshold: + revocation_threshold: description: - - (Required for new resource) Signature Threshold Value + - (Required for new resource) Revocation Threshold Value required: True type: int - plan: + location: description: - - (Required for new resource) The plan type of the HPCS Instance + - (Required for new resource) The location where the HPCS instance available required: True type: str - signature_server_url: + service_endpoints: description: - - URL of signing service + - Types of the service endpoints. Possible values are `public-and-private`, `private-only`. required: False type: str - service: + admins: description: - - The name of the service offering `hs-crypto` - required: False - type: str - default: hs-crypto - service_endpoints: + - (Required for new resource) Crypto Unit Administrators + required: True + type: list + elements: dict + name: description: - - Types of the service endpoints. Possible values are `public-and-private`, `private-only`. - required: False + - (Required for new resource) A name for the HPCS instance + required: True type: str id: description: @@ -136,30 +136,30 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('admins', 'list'), + ('signature_threshold', 'int'), + ('units', 'int'), + ('plan', 'str'), ('revocation_threshold', 'int'), ('location', 'str'), - ('units', 'int'), + ('admins', 'list'), ('name', 'str'), - ('signature_threshold', 'int'), - ('plan', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'failover_units', - 'admins', - 'revocation_threshold', - 'location', - 'units', - 'resource_group_id', - 'name', - 'tags', + 'service', 'signature_threshold', - 'plan', + 'tags', + 'resource_group_id', + 'units', 'signature_server_url', - 'service', + 'plan', + 'revocation_threshold', + 'location', 'service_endpoints', + 'admins', + 'name', ] # Params for Data source @@ -168,10 +168,10 @@ ] TL_ALL_PARAMETERS_DS = [ - 'location', - 'service', 'name', 'resource_group_id', + 'service', + 'location', ] TL_CONFLICTS_MAP = { @@ -184,42 +184,42 @@ failover_units=dict( required=False, type='int'), - admins=dict( + service=dict( required=False, - elements='', - type='list'), - revocation_threshold=dict( + type='str'), + signature_threshold=dict( required=False, type='int'), - location=dict( + tags=dict( + required=False, + elements='', + type='list'), + resource_group_id=dict( required=False, type='str'), units=dict( required=False, type='int'), - resource_group_id=dict( + signature_server_url=dict( required=False, type='str'), - name=dict( + plan=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), - signature_threshold=dict( + revocation_threshold=dict( required=False, type='int'), - plan=dict( + location=dict( required=False, type='str'), - signature_server_url=dict( + service_endpoints=dict( required=False, type='str'), - service=dict( + admins=dict( required=False, - type='str'), - service_endpoints=dict( + elements='', + type='list'), + name=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_hpcs_info.py b/plugins/modules/ibm_hpcs_info.py index 2ac7920e8..847176406 100644 --- a/plugins/modules/ibm_hpcs_info.py +++ b/plugins/modules/ibm_hpcs_info.py @@ -21,9 +21,14 @@ - Terraform v0.12.20 options: - location: + name: description: - - The location or the environment in which instance exists + - Resource instance name for example, myobjectstorage + required: True + type: str + resource_group_id: + description: + - The id of the resource group in which the instance is present required: False type: str service: @@ -32,14 +37,9 @@ required: False type: str default: hs-crypto - name: - description: - - Resource instance name for example, myobjectstorage - required: True - type: str - resource_group_id: + location: description: - - The id of the resource group in which the instance is present + - The location or the environment in which instance exists required: False type: str iaas_classic_username: @@ -80,10 +80,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'location', - 'service', 'name', 'resource_group_id', + 'service', + 'location', ] @@ -94,16 +94,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - location=dict( + name=dict( + required=True, + type='str'), + resource_group_id=dict( required=False, type='str'), service=dict( required=False, type='str'), - name=dict( - required=True, - type='str'), - resource_group_id=dict( + location=dict( required=False, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_iam_access_group_dynamic_rule.py b/plugins/modules/ibm_iam_access_group_dynamic_rule.py index 0f1f687bc..489b7fae2 100644 --- a/plugins/modules/ibm_iam_access_group_dynamic_rule.py +++ b/plugins/modules/ibm_iam_access_group_dynamic_rule.py @@ -22,17 +22,6 @@ - Terraform v0.12.20 options: - identity_provider: - description: - - (Required for new resource) The realm name or identity proivider url - required: True - type: str - conditions: - description: - - (Required for new resource) conditions info - required: True - type: list - elements: dict access_group_id: description: - (Required for new resource) Unique identifier of the access group @@ -48,6 +37,17 @@ - (Required for new resource) The expiration in hours required: True type: int + identity_provider: + description: + - (Required for new resource) The realm name or identity proivider url + required: True + type: str + conditions: + description: + - (Required for new resource) conditions info + required: True + type: list + elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -94,20 +94,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('identity_provider', 'str'), - ('conditions', 'list'), ('access_group_id', 'str'), ('name', 'str'), ('expiration', 'int'), + ('identity_provider', 'str'), + ('conditions', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'identity_provider', - 'conditions', 'access_group_id', 'name', 'expiration', + 'identity_provider', + 'conditions', ] # Params for Data source @@ -124,13 +124,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - identity_provider=dict( - required=False, - type='str'), - conditions=dict( - required=False, - elements='', - type='list'), access_group_id=dict( required=False, type='str'), @@ -140,6 +133,13 @@ expiration=dict( required=False, type='int'), + identity_provider=dict( + required=False, + type='str'), + conditions=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_iam_account_settings.py b/plugins/modules/ibm_iam_account_settings.py index 1c31f32a4..9e185ea7e 100644 --- a/plugins/modules/ibm_iam_account_settings.py +++ b/plugins/modules/ibm_iam_account_settings.py @@ -22,9 +22,20 @@ - Terraform v0.12.20 options: - restrict_create_platform_apikey: + include_history: description: - - Defines whether or not creating platform API keys is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value. + - Defines if the entity history is included in the response. + required: False + type: bool + default: False + restrict_create_service_id: + description: + - Defines whether or not creating a Service Id is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value. + required: False + type: str + allowed_ip_addresses: + description: + - Defines the IP addresses and subnets from which IAM tokens can be created for the account. required: False type: str entity_tag: @@ -43,20 +54,9 @@ - Defines the max allowed sessions per identity required by the account. Value values: * Any whole number greater than '0' * NOT_SET - To unset account setting and use service default. required: False type: str - include_history: - description: - - Defines if the entity history is included in the response. - required: False - type: bool - default: False - restrict_create_service_id: - description: - - Defines whether or not creating a Service Id is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value. - required: False - type: str - allowed_ip_addresses: + restrict_create_platform_apikey: description: - - Defines the IP addresses and subnets from which IAM tokens can be created for the account. + - Defines whether or not creating platform API keys is access controlled. Valid values: * RESTRICTED - to apply access control * NOT_RESTRICTED - to remove access control * NOT_SET - to 'unset' a previous set value. required: False type: str mfa: @@ -124,13 +124,13 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'restrict_create_platform_apikey', - 'entity_tag', - 'if_match', - 'max_sessions_per_identity', 'include_history', 'restrict_create_service_id', 'allowed_ip_addresses', + 'entity_tag', + 'if_match', + 'max_sessions_per_identity', + 'restrict_create_platform_apikey', 'mfa', 'session_expiration_in_seconds', 'session_invalidation_in_seconds', @@ -151,7 +151,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - restrict_create_platform_apikey=dict( + include_history=dict( + required=False, + type='bool'), + restrict_create_service_id=dict( + required=False, + type='str'), + allowed_ip_addresses=dict( required=False, type='str'), entity_tag=dict( @@ -163,13 +169,7 @@ max_sessions_per_identity=dict( required=False, type='str'), - include_history=dict( - required=False, - type='bool'), - restrict_create_service_id=dict( - required=False, - type='str'), - allowed_ip_addresses=dict( + restrict_create_platform_apikey=dict( required=False, type='str'), mfa=dict( diff --git a/plugins/modules/ibm_iam_api_key.py b/plugins/modules/ibm_iam_api_key.py index 7fd58d35e..33bfde48c 100644 --- a/plugins/modules/ibm_iam_api_key.py +++ b/plugins/modules/ibm_iam_api_key.py @@ -22,6 +22,21 @@ - Terraform v0.12.20 options: + apikey: + description: + - You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing in this value. + required: False + type: str + description: + description: + - The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key. + required: False + type: str + store_value: + description: + - Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing of API keys for users. + required: False + type: bool name: description: - (Required for new resource) Name of the API key. The name is not checked for uniqueness. Therefore multiple names with the same value can exist. Access is done via the UUID of the API key. @@ -38,21 +53,6 @@ required: False type: str default: false - description: - description: - - The optional description of the API key. The 'description' property is only available if a description was provided during a create of an API key. - required: False - type: str - apikey: - description: - - You can optionally passthrough the API key value for this API key. If passed, NO validation of that apiKey value is done, i.e. the value can be non-URL safe. If omitted, the API key management will create an URL safe opaque API key value. The value of the API key is checked for uniqueness. Please ensure enough variations when passing in this value. - required: False - type: str - store_value: - description: - - Send true or false to set whether the API key value is retrievable in the future by using the Get details of an API key request. If you create an API key for a user, you must specify `false` or omit the value. We don't allow storing of API keys for users. - required: False - type: bool id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -104,12 +104,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'apikey', + 'description', + 'store_value', 'name', 'file', 'entity_lock', - 'description', - 'apikey', - 'store_value', ] # Params for Data source @@ -128,24 +128,24 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + apikey=dict( required=False, type='str'), - file=dict( + description=dict( required=False, type='str'), - entity_lock=dict( + store_value=dict( required=False, - type='str'), - description=dict( + type='bool'), + name=dict( required=False, type='str'), - apikey=dict( + file=dict( required=False, type='str'), - store_value=dict( + entity_lock=dict( required=False, - type='bool'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_iam_authorization_policies_info.py b/plugins/modules/ibm_iam_authorization_policies_info.py index 8ff0072b4..2a6f8e6a0 100644 --- a/plugins/modules/ibm_iam_authorization_policies_info.py +++ b/plugins/modules/ibm_iam_authorization_policies_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - account_id: + sort: description: - - The unique ID of an account + - Sort query for policies required: False type: str - sort: + account_id: description: - - Sort query for policies + - The unique ID of an account required: False type: str iaas_classic_username: @@ -68,8 +68,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'account_id', 'sort', + 'account_id', ] @@ -80,10 +80,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - account_id=dict( + sort=dict( required=False, type='str'), - sort=dict( + account_id=dict( required=False, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_iam_authorization_policy.py b/plugins/modules/ibm_iam_authorization_policy.py index 8c208600a..8e5d98162 100644 --- a/plugins/modules/ibm_iam_authorization_policy.py +++ b/plugins/modules/ibm_iam_authorization_policy.py @@ -27,27 +27,16 @@ - Description of the Policy required: False type: str - roles: + source_service_name: description: - - (Required for new resource) Role names of the policy definition + - (Required for new resource) The source service name required: True - type: list - elements: str - target_resource_instance_id: - description: - - The target resource instance Id - required: False type: str source_resource_group_id: description: - The source resource group Id required: False type: str - source_service_account: - description: - - Account GUID of source service - required: False - type: str source_resource_type: description: - Resource type of source service @@ -58,21 +47,32 @@ - Resource type of target service required: False type: str - source_service_name: + source_service_account: description: - - (Required for new resource) The source service name - required: True + - Account GUID of source service + required: False type: str target_service_name: description: - (Required for new resource) The target service name required: True type: str + roles: + description: + - (Required for new resource) Role names of the policy definition + required: True + type: list + elements: str source_resource_instance_id: description: - The source resource instance Id required: False type: str + target_resource_instance_id: + description: + - The target resource instance Id + required: False + type: str target_resource_group_id: description: - The target resource group Id @@ -124,23 +124,23 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('roles', 'list'), ('source_service_name', 'str'), ('target_service_name', 'str'), + ('roles', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'description', - 'roles', - 'target_resource_instance_id', + 'source_service_name', 'source_resource_group_id', - 'source_service_account', 'source_resource_type', 'target_resource_type', - 'source_service_name', + 'source_service_account', 'target_service_name', + 'roles', 'source_resource_instance_id', + 'target_resource_instance_id', 'target_resource_group_id', ] @@ -161,34 +161,34 @@ description=dict( required=False, type='str'), - roles=dict( - required=False, - elements='', - type='list'), - target_resource_instance_id=dict( + source_service_name=dict( required=False, type='str'), source_resource_group_id=dict( required=False, type='str'), - source_service_account=dict( - required=False, - type='str'), source_resource_type=dict( required=False, type='str'), target_resource_type=dict( required=False, type='str'), - source_service_name=dict( + source_service_account=dict( required=False, type='str'), target_service_name=dict( required=False, type='str'), + roles=dict( + required=False, + elements='', + type='list'), source_resource_instance_id=dict( required=False, type='str'), + target_resource_instance_id=dict( + required=False, + type='str'), target_resource_group_id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_iam_custom_role.py b/plugins/modules/ibm_iam_custom_role.py index a2a68aebb..3f62a9ae4 100644 --- a/plugins/modules/ibm_iam_custom_role.py +++ b/plugins/modules/ibm_iam_custom_role.py @@ -22,32 +22,32 @@ - Terraform v0.12.20 options: - display_name: - description: - - (Required for new resource) Display Name of the Custom Role - required: True - type: str actions: description: - (Required for new resource) The actions of the role required: True type: list elements: str - name: - description: - - (Required for new resource) The name of the custom Role - required: True - type: str description: description: - The description of the role required: False type: str + name: + description: + - (Required for new resource) The name of the custom Role + required: True + type: str service: description: - (Required for new resource) The Service Name required: True type: str + display_name: + description: + - (Required for new resource) Display Name of the Custom Role + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -94,19 +94,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('display_name', 'str'), ('actions', 'list'), ('name', 'str'), ('service', 'str'), + ('display_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'display_name', 'actions', - 'name', 'description', + 'name', 'service', + 'display_name', ] # Params for Data source @@ -123,22 +123,22 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - display_name=dict( - required=False, - type='str'), actions=dict( required=False, elements='', type='list'), - name=dict( + description=dict( required=False, type='str'), - description=dict( + name=dict( required=False, type='str'), service=dict( required=False, type='str'), + display_name=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_iam_service_api_key.py b/plugins/modules/ibm_iam_service_api_key.py index 1e7bf8c51..c3842d3f5 100644 --- a/plugins/modules/ibm_iam_service_api_key.py +++ b/plugins/modules/ibm_iam_service_api_key.py @@ -22,41 +22,41 @@ - Terraform v0.12.20 options: - iam_service_id: - description: - - (Required for new resource) The service iam_id that this API key authenticates - required: True - type: str - apikey: + locked: description: - - API key value for this API key + - The API key cannot be changed if set to true required: False - type: str + type: bool store_value: description: - Boolean value deciding whether API key value is retrievable in the future required: False type: bool - file: - description: - - File where api key is to be stored - required: False - type: str name: description: - (Required for new resource) Name of the Service API key required: True type: str + iam_service_id: + description: + - (Required for new resource) The service iam_id that this API key authenticates + required: True + type: str + apikey: + description: + - API key value for this API key + required: False + type: str description: description: - description of the API key required: False type: str - locked: + file: description: - - The API key cannot be changed if set to true + - File where api key is to be stored required: False - type: bool + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -103,19 +103,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('iam_service_id', 'str'), ('name', 'str'), + ('iam_service_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'iam_service_id', - 'apikey', + 'locked', 'store_value', - 'file', 'name', + 'iam_service_id', + 'apikey', 'description', - 'locked', + 'file', ] # Params for Data source @@ -132,27 +132,27 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - iam_service_id=dict( - required=False, - type='str'), - apikey=dict( + locked=dict( required=False, - type='str'), + type='bool'), store_value=dict( required=False, type='bool'), - file=dict( + name=dict( required=False, type='str'), - name=dict( + iam_service_id=dict( + required=False, + type='str'), + apikey=dict( required=False, type='str'), description=dict( required=False, type='str'), - locked=dict( + file=dict( required=False, - type='bool'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_iam_service_id.py b/plugins/modules/ibm_iam_service_id.py index 8ca45c9ff..5c14c9bdb 100644 --- a/plugins/modules/ibm_iam_service_id.py +++ b/plugins/modules/ibm_iam_service_id.py @@ -22,12 +22,6 @@ - Terraform v0.12.20 options: - tags: - description: - - None - required: False - type: list - elements: str name: description: - (Required for new resource) Name of the serviceID @@ -38,6 +32,12 @@ - Description of the serviceID required: False type: str + tags: + description: + - None + required: False + type: list + elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -89,9 +89,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'tags', 'name', 'description', + 'tags', ] # Params for Data source @@ -110,16 +110,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - tags=dict( - required=False, - elements='', - type='list'), name=dict( required=False, type='str'), description=dict( required=False, type='str'), + tags=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_iam_service_policy.py b/plugins/modules/ibm_iam_service_policy.py index 1b40f3438..da569b28f 100644 --- a/plugins/modules/ibm_iam_service_policy.py +++ b/plugins/modules/ibm_iam_service_policy.py @@ -22,6 +22,28 @@ - Terraform v0.12.20 options: + account_management: + description: + - Give access to all account management services + required: False + type: bool + default: False + tags: + description: + - None + required: False + type: list + elements: str + description: + description: + - Description of the Policy + required: False + type: str + iam_service_id: + description: + - UUID of ServiceID + required: False + type: str iam_id: description: - IAM ID of ServiceID @@ -45,28 +67,6 @@ required: False type: list elements: dict - account_management: - description: - - Give access to all account management services - required: False - type: bool - default: False - tags: - description: - - None - required: False - type: list - elements: str - description: - description: - - Description of the Policy - required: False - type: str - iam_service_id: - description: - - UUID of ServiceID - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -118,14 +118,14 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'iam_id', - 'roles', - 'resources', - 'resource_attributes', 'account_management', 'tags', 'description', 'iam_service_id', + 'iam_id', + 'roles', + 'resources', + 'resource_attributes', ] # Params for Data source @@ -133,21 +133,34 @@ ] TL_ALL_PARAMETERS_DS = [ + 'sort', 'iam_service_id', 'iam_id', - 'sort', ] TL_CONFLICTS_MAP = { + 'account_management': ['resources', 'resource_attributes'], 'resources': ['account_management', 'resource_attributes'], 'resource_attributes': ['resources', 'account_management'], - 'account_management': ['resources', 'resource_attributes'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + account_management=dict( + required=False, + type='bool'), + tags=dict( + required=False, + elements='', + type='list'), + description=dict( + required=False, + type='str'), + iam_service_id=dict( + required=False, + type='str'), iam_id=dict( required=False, type='str'), @@ -163,19 +176,6 @@ required=False, elements='', type='list'), - account_management=dict( - required=False, - type='bool'), - tags=dict( - required=False, - elements='', - type='list'), - description=dict( - required=False, - type='str'), - iam_service_id=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_iam_service_policy_info.py b/plugins/modules/ibm_iam_service_policy_info.py index 183df6086..e10afddee 100644 --- a/plugins/modules/ibm_iam_service_policy_info.py +++ b/plugins/modules/ibm_iam_service_policy_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + sort: + description: + - Sort query for policies + required: False + type: str iam_service_id: description: - UUID of ServiceID @@ -31,11 +36,6 @@ - IAM ID of ServiceID required: False type: str - sort: - description: - - Sort query for policies - required: False - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -73,9 +73,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'sort', 'iam_service_id', 'iam_id', - 'sort', ] @@ -86,13 +86,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - iam_service_id=dict( + sort=dict( required=False, type='str'), - iam_id=dict( + iam_service_id=dict( required=False, type='str'), - sort=dict( + iam_id=dict( required=False, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_iam_trusted_profile.py b/plugins/modules/ibm_iam_trusted_profile.py index 413159d03..f70f03d4b 100644 --- a/plugins/modules/ibm_iam_trusted_profile.py +++ b/plugins/modules/ibm_iam_trusted_profile.py @@ -22,16 +22,16 @@ - Terraform v0.12.20 options: - name: - description: - - (Required for new resource) Name of the trusted profile. The name is checked for uniqueness. Therefore trusted profiles with the same names can not exist in the same account. - required: True - type: str description: description: - The optional description of the trusted profile. The 'description' property is only available if a description was provided during creation of trusted profile. required: False type: str + name: + description: + - (Required for new resource) Name of the trusted profile. The name is checked for uniqueness. Therefore trusted profiles with the same names can not exist in the same account. + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -83,8 +83,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'description', + 'name', ] # Params for Data source @@ -103,10 +103,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + description=dict( required=False, type='str'), - description=dict( + name=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_iam_trusted_profile_claim_rule.py b/plugins/modules/ibm_iam_trusted_profile_claim_rule.py index 79e053d52..aeaa95747 100644 --- a/plugins/modules/ibm_iam_trusted_profile_claim_rule.py +++ b/plugins/modules/ibm_iam_trusted_profile_claim_rule.py @@ -22,42 +22,42 @@ - Terraform v0.12.20 options: - expiration: + cr_type: description: - - Session expiration in seconds, only required if type is 'Profile-SAML'. + - The compute resource type the rule applies to, required only if type is specified as 'Profile-CR'. Valid values are VSI, IKS_SA, ROKS_SA. required: False - type: int - profile_id: - description: - - (Required for new resource) ID of the trusted profile to create a claim rule. - required: True type: str - conditions: + type: description: - - (Required for new resource) Conditions of this claim rule. + - (Required for new resource) Type of the calim rule, either 'Profile-SAML' or 'Profile-CR'. required: True - type: list - elements: dict + type: str name: description: - Name of the claim rule to be created or updated. required: False type: str - type: - description: - - (Required for new resource) Type of the calim rule, either 'Profile-SAML' or 'Profile-CR'. - required: True - type: str realm_name: description: - The realm name of the Idp this claim rule applies to. This field is required only if the type is specified as 'Profile-SAML'. required: False type: str - cr_type: + expiration: description: - - The compute resource type the rule applies to, required only if type is specified as 'Profile-CR'. Valid values are VSI, IKS_SA, ROKS_SA. + - Session expiration in seconds, only required if type is 'Profile-SAML'. required: False + type: int + profile_id: + description: + - (Required for new resource) ID of the trusted profile to create a claim rule. + required: True type: str + conditions: + description: + - (Required for new resource) Conditions of this claim rule. + required: True + type: list + elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -104,31 +104,31 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('type', 'str'), ('profile_id', 'str'), ('conditions', 'list'), - ('type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'cr_type', + 'type', + 'name', + 'realm_name', 'expiration', 'profile_id', 'conditions', - 'name', - 'type', - 'realm_name', - 'cr_type', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('rule_id', 'str'), ('profile_id', 'str'), + ('rule_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'rule_id', 'profile_id', + 'rule_id', ] TL_CONFLICTS_MAP = { @@ -138,28 +138,28 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - expiration=dict( - required=False, - type='int'), - profile_id=dict( + cr_type=dict( required=False, type='str'), - conditions=dict( - required=False, - elements='', - type='list'), - name=dict( + type=dict( required=False, type='str'), - type=dict( + name=dict( required=False, type='str'), realm_name=dict( required=False, type='str'), - cr_type=dict( + expiration=dict( + required=False, + type='int'), + profile_id=dict( required=False, type='str'), + conditions=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_iam_trusted_profile_claim_rule_info.py b/plugins/modules/ibm_iam_trusted_profile_claim_rule_info.py index de748eb50..3cbf22ff6 100644 --- a/plugins/modules/ibm_iam_trusted_profile_claim_rule_info.py +++ b/plugins/modules/ibm_iam_trusted_profile_claim_rule_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - rule_id: + profile_id: description: - - ID of the claim rule to get. + - ID of the trusted profile. required: True type: str - profile_id: + rule_id: description: - - ID of the trusted profile. + - ID of the claim rule to get. required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('rule_id', 'str'), ('profile_id', 'str'), + ('rule_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'rule_id', 'profile_id', + 'rule_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - rule_id=dict( + profile_id=dict( required=True, type='str'), - profile_id=dict( + rule_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_iam_trusted_profile_link.py b/plugins/modules/ibm_iam_trusted_profile_link.py index 682edcfc7..54752a155 100644 --- a/plugins/modules/ibm_iam_trusted_profile_link.py +++ b/plugins/modules/ibm_iam_trusted_profile_link.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + profile_id: + description: + - (Required for new resource) ID of the trusted profile. + required: True + type: str cr_type: description: - (Required for new resource) The compute resource type. Valid values are VSI, IKS_SA, ROKS_SA. @@ -38,11 +43,6 @@ - Optional name of the Link. required: False type: str - profile_id: - description: - - (Required for new resource) ID of the trusted profile. - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -89,28 +89,28 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('profile_id', 'str'), ('cr_type', 'str'), ('link', 'list'), - ('profile_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'profile_id', 'cr_type', 'link', 'name', - 'profile_id', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('profile_id', 'str'), ('link_id', 'str'), + ('profile_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'profile_id', 'link_id', + 'profile_id', ] TL_CONFLICTS_MAP = { @@ -120,6 +120,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + profile_id=dict( + required=False, + type='str'), cr_type=dict( required=False, type='str'), @@ -130,9 +133,6 @@ name=dict( required=False, type='str'), - profile_id=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_iam_trusted_profile_link_info.py b/plugins/modules/ibm_iam_trusted_profile_link_info.py index ff0dfd6cf..d2c2a9010 100644 --- a/plugins/modules/ibm_iam_trusted_profile_link_info.py +++ b/plugins/modules/ibm_iam_trusted_profile_link_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - profile_id: + link_id: description: - - ID of the trusted profile. + - ID of the link. required: True type: str - link_id: + profile_id: description: - - ID of the link. + - ID of the trusted profile. required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('profile_id', 'str'), ('link_id', 'str'), + ('profile_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'profile_id', 'link_id', + 'profile_id', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - profile_id=dict( + link_id=dict( required=True, type='str'), - link_id=dict( + profile_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_iam_trusted_profile_policy.py b/plugins/modules/ibm_iam_trusted_profile_policy.py index 0c74c6b9c..794adc0ed 100644 --- a/plugins/modules/ibm_iam_trusted_profile_policy.py +++ b/plugins/modules/ibm_iam_trusted_profile_policy.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + profile_id: + description: + - UUID of Trusted Profile + required: False + type: str + iam_id: + description: + - IAM ID of Trusted Profile + required: False + type: str roles: description: - (Required for new resource) Role names of the policy definition @@ -57,16 +67,6 @@ - Description of the Policy required: False type: str - profile_id: - description: - - UUID of Trusted Profile - required: False - type: str - iam_id: - description: - - IAM ID of Trusted Profile - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -118,14 +118,14 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'profile_id', + 'iam_id', 'roles', 'resources', 'resource_attributes', 'account_management', 'tags', 'description', - 'profile_id', - 'iam_id', ] # Params for Data source @@ -148,6 +148,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + profile_id=dict( + required=False, + type='str'), + iam_id=dict( + required=False, + type='str'), roles=dict( required=False, elements='', @@ -170,12 +176,6 @@ description=dict( required=False, type='str'), - profile_id=dict( - required=False, - type='str'), - iam_id=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_ipsec_vpn.py b/plugins/modules/ibm_ipsec_vpn.py index 88ca1eeb3..e23f80c48 100644 --- a/plugins/modules/ibm_ipsec_vpn.py +++ b/plugins/modules/ibm_ipsec_vpn.py @@ -22,24 +22,45 @@ - Terraform v0.12.20 options: + remote_subnet: + description: + - None + required: False + type: list + elements: dict datacenter: description: - (Required for new resource) Datacenter name required: True type: str - phase_one: + address_translation: description: - None required: False type: list elements: dict - phase_two: + customer_peer_ip: + description: + - Customer Peer IP Address + required: False + type: str + internal_subnet_id: + description: + - Internal subnet ID value + required: False + type: int + remote_subnet_id: + description: + - Remote subnet ID value + required: False + type: int + phase_one: description: - None required: False type: list elements: dict - address_translation: + phase_two: description: - None required: False @@ -50,32 +71,11 @@ - Preshared Key data required: False type: str - remote_subnet_id: - description: - - Remote subnet ID value - required: False - type: int service_subnet_id: description: - Service subnet ID value required: False type: int - customer_peer_ip: - description: - - Customer Peer IP Address - required: False - type: str - internal_subnet_id: - description: - - Internal subnet ID value - required: False - type: int - remote_subnet: - description: - - None - required: False - type: list - elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -127,16 +127,16 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'remote_subnet', 'datacenter', + 'address_translation', + 'customer_peer_ip', + 'internal_subnet_id', + 'remote_subnet_id', 'phase_one', 'phase_two', - 'address_translation', 'preshared_key', - 'remote_subnet_id', 'service_subnet_id', - 'customer_peer_ip', - 'internal_subnet_id', - 'remote_subnet', ] # Params for Data source @@ -147,48 +147,48 @@ ] TL_CONFLICTS_MAP = { - 'remote_subnet_id': ['remote_subnet'], 'remote_subnet': ['remote_subnet_id'], + 'remote_subnet_id': ['remote_subnet'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - datacenter=dict( - required=False, - type='str'), - phase_one=dict( + remote_subnet=dict( required=False, elements='', type='list'), - phase_two=dict( + datacenter=dict( required=False, - elements='', - type='list'), + type='str'), address_translation=dict( required=False, elements='', type='list'), - preshared_key=dict( + customer_peer_ip=dict( required=False, type='str'), - remote_subnet_id=dict( + internal_subnet_id=dict( required=False, type='int'), - service_subnet_id=dict( + remote_subnet_id=dict( required=False, type='int'), - customer_peer_ip=dict( - required=False, - type='str'), - internal_subnet_id=dict( + phase_one=dict( required=False, - type='int'), - remote_subnet=dict( + elements='', + type='list'), + phase_two=dict( required=False, elements='', type='list'), + preshared_key=dict( + required=False, + type='str'), + service_subnet_id=dict( + required=False, + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_dedicated_host.py b/plugins/modules/ibm_is_dedicated_host.py index 203d3b564..ce387c527 100644 --- a/plugins/modules/ibm_is_dedicated_host.py +++ b/plugins/modules/ibm_is_dedicated_host.py @@ -22,32 +22,32 @@ - Terraform v0.12.20 options: - resource_group: - description: - - The unique identifier for the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. - required: False - type: str - name: + profile: description: - - The unique user-defined name for this dedicated host. If unspecified, the name will be a hyphenated list of randomly-selected words. - required: False + - (Required for new resource) The Globally unique name of the dedicated host profile to use for this dedicated host. + required: True type: str host_group: description: - (Required for new resource) The unique identifier of the dedicated host group for this dedicated host. required: True type: str - profile: - description: - - (Required for new resource) The Globally unique name of the dedicated host profile to use for this dedicated host. - required: True - type: str instance_placement_enabled: description: - If set to true, instances can be placed on this dedicated host. required: False type: bool default: True + name: + description: + - The unique user-defined name for this dedicated host. If unspecified, the name will be a hyphenated list of randomly-selected words. + required: False + type: str + resource_group: + description: + - The unique identifier for the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -94,29 +94,29 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('host_group', 'str'), ('profile', 'str'), + ('host_group', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'resource_group', - 'name', - 'host_group', 'profile', + 'host_group', 'instance_placement_enabled', + 'name', + 'resource_group', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('name', 'str'), ('host_group', 'str'), + ('name', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'name', 'host_group', 'resource_group', + 'name', ] TL_CONFLICTS_MAP = { @@ -126,21 +126,21 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - resource_group=dict( - required=False, - type='str'), - name=dict( + profile=dict( required=False, type='str'), host_group=dict( required=False, type='str'), - profile=dict( - required=False, - type='str'), instance_placement_enabled=dict( required=False, type='bool'), + name=dict( + required=False, + type='str'), + resource_group=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_dedicated_host_disk_info.py b/plugins/modules/ibm_is_dedicated_host_disk_info.py index 5ff13cc90..d21141997 100644 --- a/plugins/modules/ibm_is_dedicated_host_disk_info.py +++ b/plugins/modules/ibm_is_dedicated_host_disk_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - dedicated_host: + disk: description: - - The dedicated host identifier. + - The dedicated host disk identifier. required: True type: str - disk: + dedicated_host: description: - - The dedicated host disk identifier. + - The dedicated host identifier. required: True type: str generation: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('dedicated_host', 'str'), ('disk', 'str'), + ('dedicated_host', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'dedicated_host', 'disk', + 'dedicated_host', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - dedicated_host=dict( + disk=dict( required=True, type='str'), - disk=dict( + dedicated_host=dict( required=True, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_dedicated_host_group.py b/plugins/modules/ibm_is_dedicated_host_group.py index 1c8d6c9ae..ad60be5c0 100644 --- a/plugins/modules/ibm_is_dedicated_host_group.py +++ b/plugins/modules/ibm_is_dedicated_host_group.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - name: - description: - - The unique user-defined name for this dedicated host group. If unspecified, the name will be a hyphenated list of randomly-selected words. - required: False - type: str class_: description: - (Required for new resource) The dedicated host profile class for hosts in this group. @@ -37,6 +32,11 @@ - (Required for new resource) The dedicated host profile family for hosts in this group. required: True type: str + name: + description: + - The unique user-defined name for this dedicated host group. If unspecified, the name will be a hyphenated list of randomly-selected words. + required: False + type: str resource_group: description: - The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. @@ -100,9 +100,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'class_', 'family', + 'name', 'resource_group', 'zone', ] @@ -123,15 +123,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=False, - type='str'), class_=dict( required=False, type='str'), family=dict( required=False, type='str'), + name=dict( + required=False, + type='str'), resource_group=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_dedicated_host_info.py b/plugins/modules/ibm_is_dedicated_host_info.py index f79c36250..f96714bce 100644 --- a/plugins/modules/ibm_is_dedicated_host_info.py +++ b/plugins/modules/ibm_is_dedicated_host_info.py @@ -21,11 +21,6 @@ - Terraform v0.12.20 options: - name: - description: - - The unique name of this dedicated host - required: True - type: str host_group: description: - The unique identifier of the dedicated host group this dedicated host belongs to @@ -36,6 +31,11 @@ - The unique identifier of the resource group this dedicated host belongs to required: False type: str + name: + description: + - The unique name of this dedicated host + required: True + type: str generation: description: - The generation of Virtual Private Cloud infrastructure @@ -69,15 +69,15 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('host_group', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'host_group', 'resource_group', + 'name', ] @@ -88,15 +88,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=True, - type='str'), host_group=dict( required=True, type='str'), resource_group=dict( required=False, type='str'), + name=dict( + required=True, + type='str'), generation=dict( type='int', required=False, diff --git a/plugins/modules/ibm_is_floating_ip.py b/plugins/modules/ibm_is_floating_ip.py index 6ad237ef9..cee7f963d 100644 --- a/plugins/modules/ibm_is_floating_ip.py +++ b/plugins/modules/ibm_is_floating_ip.py @@ -22,32 +22,32 @@ - Terraform v0.12.20 options: - target: - description: - - Target info - required: False - type: str - resource_group: - description: - - Resource group info - required: False - type: str name: description: - (Required for new resource) Name of the floating IP required: True type: str + tags: + description: + - Floating IP tags + required: False + type: list + elements: str zone: description: - Zone name required: False type: str - tags: + target: description: - - Floating IP tags + - Target info required: False - type: list - elements: str + type: str + resource_group: + description: + - Resource group info + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -99,11 +99,11 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'target', - 'resource_group', 'name', - 'zone', 'tags', + 'zone', + 'target', + 'resource_group', ] # Params for Data source @@ -116,30 +116,30 @@ ] TL_CONFLICTS_MAP = { - 'target': ['zone'], 'zone': ['target'], + 'target': ['zone'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - target=dict( + name=dict( required=False, type='str'), - resource_group=dict( + tags=dict( required=False, - type='str'), - name=dict( + elements='', + type='list'), + zone=dict( required=False, type='str'), - zone=dict( + target=dict( required=False, type='str'), - tags=dict( + resource_group=dict( required=False, - elements='', - type='list'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_flow_log.py b/plugins/modules/ibm_is_flow_log.py index b0fda12f9..8e1ea908a 100644 --- a/plugins/modules/ibm_is_flow_log.py +++ b/plugins/modules/ibm_is_flow_log.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + storage_bucket: + description: + - (Required for new resource) The Cloud Object Storage bucket name where the collected flows will be logged + required: True + type: str tags: description: - Tags for the VPC Flow logs @@ -33,11 +38,6 @@ - (Required for new resource) Flow Log Collector name required: True type: str - storage_bucket: - description: - - (Required for new resource) The Cloud Object Storage bucket name where the collected flows will be logged - required: True - type: str target: description: - (Required for new resource) The target id that the flow log collector is to collect flow logs @@ -100,16 +100,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('storage_bucket', 'str'), + ('name', 'str'), ('target', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'storage_bucket', 'tags', 'name', - 'storage_bucket', 'target', 'active', 'resource_group', @@ -131,6 +131,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + storage_bucket=dict( + required=False, + type='str'), tags=dict( required=False, elements='', @@ -138,9 +141,6 @@ name=dict( required=False, type='str'), - storage_bucket=dict( - required=False, - type='str'), target=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_ike_policy.py b/plugins/modules/ibm_is_ike_policy.py index 0a0edb669..7a4a7b770 100644 --- a/plugins/modules/ibm_is_ike_policy.py +++ b/plugins/modules/ibm_is_ike_policy.py @@ -22,11 +22,17 @@ - Terraform v0.12.20 options: - name: + resource_group: description: - - (Required for new resource) IKE name - required: True + - IKE resource group ID + required: False type: str + key_lifetime: + description: + - IKE Key lifetime + required: False + type: int + default: 28800 authentication_algorithm: description: - (Required for new resource) Authentication algorithm type @@ -37,27 +43,21 @@ - (Required for new resource) Encryption alogorithm type required: True type: str - key_lifetime: - description: - - IKE Key lifetime - required: False - type: int - default: 28800 dh_group: description: - (Required for new resource) IKE DH group required: True type: int - resource_group: - description: - - IKE resource group ID - required: False - type: str ike_version: description: - IKE version required: False type: int + name: + description: + - (Required for new resource) IKE name + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -104,21 +104,21 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('authentication_algorithm', 'str'), ('encryption_algorithm', 'str'), ('dh_group', 'int'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', + 'resource_group', + 'key_lifetime', 'authentication_algorithm', 'encryption_algorithm', - 'key_lifetime', 'dh_group', - 'resource_group', 'ike_version', + 'name', ] # Params for Data source @@ -135,27 +135,27 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + resource_group=dict( required=False, type='str'), + key_lifetime=dict( + required=False, + type='int'), authentication_algorithm=dict( required=False, type='str'), encryption_algorithm=dict( required=False, type='str'), - key_lifetime=dict( - required=False, - type='int'), dh_group=dict( required=False, type='int'), - resource_group=dict( - required=False, - type='str'), ike_version=dict( required=False, type='int'), + name=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_image.py b/plugins/modules/ibm_is_image.py index 6868f5e3f..a27b91dc8 100644 --- a/plugins/modules/ibm_is_image.py +++ b/plugins/modules/ibm_is_image.py @@ -27,6 +27,11 @@ - A base64-encoded, encrypted representation of the key that was used to encrypt the data for this image required: False type: str + name: + description: + - (Required for new resource) Image name + required: True + type: str source_volume: description: - Image volume id @@ -37,30 +42,25 @@ - The resource group for this image required: False type: str - href: - description: - - Image Href value - required: False - type: str - name: - description: - - (Required for new resource) Image name - required: True - type: str tags: description: - Tags for the image required: False type: list elements: str + encryption_key: + description: + - The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource + required: False + type: str operating_system: description: - Image Operating system required: False type: str - encryption_key: + href: description: - - The CRN of the Key Protect Root Key or Hyper Protect Crypto Service Root Key for this resource + - Image Href value required: False type: str id: @@ -115,13 +115,13 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'encrypted_data_key', + 'name', 'source_volume', 'resource_group', - 'href', - 'name', 'tags', - 'operating_system', 'encryption_key', + 'operating_system', + 'href', ] # Params for Data source @@ -130,8 +130,8 @@ TL_ALL_PARAMETERS_DS = [ 'name', - 'identifier', 'visibility', + 'identifier', ] TL_CONFLICTS_MAP = { @@ -144,26 +144,26 @@ encrypted_data_key=dict( required=False, type='str'), - source_volume=dict( - required=False, - type='str'), - resource_group=dict( + name=dict( required=False, type='str'), - href=dict( + source_volume=dict( required=False, type='str'), - name=dict( + resource_group=dict( required=False, type='str'), tags=dict( required=False, elements='', type='list'), + encryption_key=dict( + required=False, + type='str'), operating_system=dict( required=False, type='str'), - encryption_key=dict( + href=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_is_image_info.py b/plugins/modules/ibm_is_image_info.py index f9a8a42d9..8ec0e041c 100644 --- a/plugins/modules/ibm_is_image_info.py +++ b/plugins/modules/ibm_is_image_info.py @@ -26,14 +26,14 @@ - Image name required: False type: str - identifier: + visibility: description: - - Image id + - Whether the image is publicly visible or private to the account required: False type: str - visibility: + identifier: description: - - Whether the image is publicly visible or private to the account + - Image id required: False type: str generation: @@ -74,8 +74,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'name', - 'identifier', 'visibility', + 'identifier', ] @@ -89,10 +89,10 @@ name=dict( required=False, type='str'), - identifier=dict( + visibility=dict( required=False, type='str'), - visibility=dict( + identifier=dict( required=False, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_instance.py b/plugins/modules/ibm_is_instance.py index bcd5edd8c..0b3a2ef1f 100644 --- a/plugins/modules/ibm_is_instance.py +++ b/plugins/modules/ibm_is_instance.py @@ -22,129 +22,129 @@ - Terraform v0.12.20 options: - keys: - description: - - SSH key Ids for the instance - required: False - type: list - elements: str - image: + profile: description: - - image id + - Profile info required: False type: str - boot_volume: - description: - - None - required: False - type: list - elements: dict - force_recovery_time: - description: - - Define timeout to force the instances to start/stop in minutes. - required: False - type: int - total_volume_bandwidth: + dedicated_host: description: - - The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes + - Unique Identifier of the Dedicated Host where the instance will be placed required: False - type: int + type: str auto_delete_volume: description: - Auto delete volume along with instance required: False type: bool - resource_group: + placement_group: description: - - Instance resource group + - Unique Identifier of the Placement Group for restricting the placement of the instance required: False type: str - force_action: - description: - - If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action. - required: False - type: bool - default: False - wait_before_delete: + instance_template: description: - - Enables stopping of instance before deleting and waits till deletion is complete + - Id of the instance template required: False - type: bool - default: True + type: str tags: description: - list of tags for the instance required: False type: list elements: str - volumes: + primary_network_interface: description: - - List of volumes + - Primary Network interface info required: False type: list - elements: str - placement_group: + elements: dict + image: description: - - Unique Identifier of the Placement Group for restricting the placement of the instance + - image id required: False type: str - zone: + name: description: - - Zone name - required: False + - (Required for new resource) Instance name + required: True type: str - action: + boot_volume: description: - - Enables stopping of instance before deleting and waits till deletion is complete + - None + required: False + type: list + elements: dict + vpc: + description: + - VPC id required: False type: str - name: + resource_group: description: - - (Required for new resource) Instance name - required: True + - Instance resource group + required: False type: str dedicated_host_group: description: - Unique Identifier of the Dedicated Host Group where the instance will be placed required: False type: str - user_data: + total_volume_bandwidth: description: - - User data given for the instance + - The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes required: False - type: str - vpc: + type: int + wait_before_delete: description: - - VPC id + - Enables stopping of instance before deleting and waits till deletion is complete required: False - type: str - profile: + type: bool + default: True + action: description: - - Profile info + - Enables stopping of instance before deleting and waits till deletion is complete required: False type: str - dedicated_host: + network_interfaces: description: - - Unique Identifier of the Dedicated Host where the instance will be placed + - None required: False - type: str - primary_network_interface: + type: list + elements: dict + volumes: description: - - Primary Network interface info + - List of volumes required: False type: list - elements: dict - network_interfaces: + elements: str + zone: description: - - None + - Zone name + required: False + type: str + keys: + description: + - SSH key Ids for the instance required: False type: list - elements: dict - instance_template: + elements: str + force_action: description: - - Id of the instance template + - If set to true, the action will be forced immediately, and all queued actions deleted. Ignored for the start action. + required: False + type: bool + default: False + user_data: + description: + - User data given for the instance required: False type: str + force_recovery_time: + description: + - Define timeout to force the instances to start/stop in minutes. + required: False + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -196,29 +196,29 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'keys', + 'profile', + 'dedicated_host', + 'auto_delete_volume', + 'placement_group', + 'instance_template', + 'tags', + 'primary_network_interface', 'image', + 'name', 'boot_volume', - 'force_recovery_time', - 'total_volume_bandwidth', - 'auto_delete_volume', + 'vpc', 'resource_group', - 'force_action', + 'dedicated_host_group', + 'total_volume_bandwidth', 'wait_before_delete', - 'tags', + 'action', + 'network_interfaces', 'volumes', - 'placement_group', 'zone', - 'action', - 'name', - 'dedicated_host_group', + 'keys', + 'force_action', 'user_data', - 'vpc', - 'profile', - 'dedicated_host', - 'primary_network_interface', - 'network_interfaces', - 'instance_template', + 'force_recovery_time', ] # Params for Data source @@ -227,98 +227,98 @@ ] TL_ALL_PARAMETERS_DS = [ - 'private_key', - 'name', 'passphrase', + 'name', + 'private_key', ] TL_CONFLICTS_MAP = { - 'image': ['boot_volume.0.snapshot'], - 'placement_group': ['dedicated_host', 'dedicated_host_group'], - 'dedicated_host_group': ['dedicated_host', 'placement_group'], 'dedicated_host': ['dedicated_host_group', 'placement_group'], + 'placement_group': ['dedicated_host', 'dedicated_host_group'], 'instance_template': ['boot_volume.0.snapshot'], + 'image': ['boot_volume.0.snapshot'], + 'dedicated_host_group': ['dedicated_host', 'placement_group'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - keys=dict( - required=False, - elements='', - type='list'), - image=dict( + profile=dict( required=False, type='str'), - boot_volume=dict( - required=False, - elements='', - type='list'), - force_recovery_time=dict( - required=False, - type='int'), - total_volume_bandwidth=dict( + dedicated_host=dict( required=False, - type='int'), + type='str'), auto_delete_volume=dict( required=False, type='bool'), - resource_group=dict( + placement_group=dict( required=False, type='str'), - force_action=dict( - required=False, - type='bool'), - wait_before_delete=dict( + instance_template=dict( required=False, - type='bool'), + type='str'), tags=dict( required=False, elements='', type='list'), - volumes=dict( + primary_network_interface=dict( required=False, elements='', type='list'), - placement_group=dict( + image=dict( required=False, type='str'), - zone=dict( + name=dict( required=False, type='str'), - action=dict( + boot_volume=dict( + required=False, + elements='', + type='list'), + vpc=dict( required=False, type='str'), - name=dict( + resource_group=dict( required=False, type='str'), dedicated_host_group=dict( required=False, type='str'), - user_data=dict( + total_volume_bandwidth=dict( required=False, - type='str'), - vpc=dict( + type='int'), + wait_before_delete=dict( required=False, - type='str'), - profile=dict( + type='bool'), + action=dict( required=False, type='str'), - dedicated_host=dict( + network_interfaces=dict( required=False, - type='str'), - primary_network_interface=dict( + elements='', + type='list'), + volumes=dict( required=False, elements='', type='list'), - network_interfaces=dict( + zone=dict( + required=False, + type='str'), + keys=dict( required=False, elements='', type='list'), - instance_template=dict( + force_action=dict( + required=False, + type='bool'), + user_data=dict( required=False, type='str'), + force_recovery_time=dict( + required=False, + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_instance_group.py b/plugins/modules/ibm_is_instance_group.py index bc97e680e..9c914b456 100644 --- a/plugins/modules/ibm_is_instance_group.py +++ b/plugins/modules/ibm_is_instance_group.py @@ -22,6 +22,12 @@ - Terraform v0.12.20 options: + tags: + description: + - List of tags for instance group + required: False + type: list + elements: str instance_template: description: - (Required for new resource) instance template ID @@ -38,22 +44,11 @@ - Used by the instance group when scaling up instances to supply the port for the load balancer pool member. required: False type: int - load_balancer: - description: - - load balancer ID - required: False - type: str load_balancer_pool: description: - load balancer pool ID required: False type: str - tags: - description: - - List of tags for instance group - required: False - type: list - elements: str resource_group: description: - Resource group ID @@ -65,6 +60,11 @@ required: True type: list elements: str + load_balancer: + description: + - load balancer ID + required: False + type: str name: description: - (Required for new resource) The user-defined name for this instance group @@ -123,14 +123,14 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'tags', 'instance_template', 'instance_count', 'application_port', - 'load_balancer', 'load_balancer_pool', - 'tags', 'resource_group', 'subnets', + 'load_balancer', 'name', ] @@ -150,6 +150,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + tags=dict( + required=False, + elements='', + type='list'), instance_template=dict( required=False, type='str'), @@ -159,16 +163,9 @@ application_port=dict( required=False, type='int'), - load_balancer=dict( - required=False, - type='str'), load_balancer_pool=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), resource_group=dict( required=False, type='str'), @@ -176,6 +173,9 @@ required=False, elements='', type='list'), + load_balancer=dict( + required=False, + type='str'), name=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_instance_group_manager.py b/plugins/modules/ibm_is_instance_group_manager.py index 6d6a562b0..2830e6884 100644 --- a/plugins/modules/ibm_is_instance_group_manager.py +++ b/plugins/modules/ibm_is_instance_group_manager.py @@ -22,51 +22,51 @@ - Terraform v0.12.20 options: - instance_group: - description: - - (Required for new resource) instance group ID - required: True - type: str - manager_type: + name: description: - - The type of instance group manager. + - instance group manager name required: False type: str - default: autoscale - aggregation_window: - description: - - The time window in seconds to aggregate metrics prior to evaluation - required: False - type: int - default: 90 cooldown: description: - The duration of time in seconds to pause further scale actions after scaling has taken place required: False type: int default: 300 + min_membership_count: + description: + - The minimum number of members in a managed instance group + required: False + type: int + default: 1 enable_manager: description: - enable instance group manager required: False type: bool default: True - max_membership_count: + instance_group: description: - - The maximum number of members in a managed instance group + - (Required for new resource) instance group ID + required: True + type: str + manager_type: + description: + - The type of instance group manager. required: False - type: int - min_membership_count: + type: str + default: autoscale + aggregation_window: description: - - The minimum number of members in a managed instance group + - The time window in seconds to aggregate metrics prior to evaluation required: False type: int - default: 1 - name: + default: 90 + max_membership_count: description: - - instance group manager name + - The maximum number of members in a managed instance group required: False - type: str + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -118,14 +118,14 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'name', + 'cooldown', + 'min_membership_count', + 'enable_manager', 'instance_group', 'manager_type', 'aggregation_window', - 'cooldown', - 'enable_manager', 'max_membership_count', - 'min_membership_count', - 'name', ] # Params for Data source @@ -146,30 +146,30 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance_group=dict( - required=False, - type='str'), - manager_type=dict( + name=dict( required=False, type='str'), - aggregation_window=dict( + cooldown=dict( required=False, type='int'), - cooldown=dict( + min_membership_count=dict( required=False, type='int'), enable_manager=dict( required=False, type='bool'), - max_membership_count=dict( + instance_group=dict( required=False, - type='int'), - min_membership_count=dict( + type='str'), + manager_type=dict( + required=False, + type='str'), + aggregation_window=dict( required=False, type='int'), - name=dict( + max_membership_count=dict( required=False, - type='str'), + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_instance_group_manager_action.py b/plugins/modules/ibm_is_instance_group_manager_action.py index b4685e48c..530a922f2 100644 --- a/plugins/modules/ibm_is_instance_group_manager_action.py +++ b/plugins/modules/ibm_is_instance_group_manager_action.py @@ -22,21 +22,11 @@ - Terraform v0.12.20 options: - instance_group: - description: - - (Required for new resource) instance group ID - required: True - type: str - membership_count: - description: - - The number of members the instance group should have at the scheduled time. - required: False - type: int - max_membership_count: + name: description: - - The maximum number of members in a managed instance group + - instance group manager action name required: False - type: int + type: str target_manager: description: - The unique identifier for this instance group manager of type autoscale. @@ -47,10 +37,15 @@ - The cron specification for a recurring scheduled action. Actions can be applied a maximum of one time within a 5 min period. required: False type: str - name: + membership_count: description: - - instance group manager action name + - The number of members the instance group should have at the scheduled time. required: False + type: int + instance_group_manager: + description: + - (Required for new resource) Instance group manager ID of type scheduled + required: True type: str min_membership_count: description: @@ -58,9 +53,9 @@ required: False type: int default: 1 - instance_group_manager: + instance_group: description: - - (Required for new resource) Instance group manager ID of type scheduled + - (Required for new resource) instance group ID required: True type: str run_at: @@ -68,6 +63,11 @@ - The date and time the scheduled action will run. required: False type: str + max_membership_count: + description: + - The maximum number of members in a managed instance group + required: False + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -114,76 +114,76 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('instance_group', 'str'), ('instance_group_manager', 'str'), + ('instance_group', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'instance_group', - 'membership_count', - 'max_membership_count', + 'name', 'target_manager', 'cron_spec', - 'name', - 'min_membership_count', + 'membership_count', 'instance_group_manager', + 'min_membership_count', + 'instance_group', 'run_at', + 'max_membership_count', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ + ('instance_group', 'str'), ('name', 'str'), ('instance_group_manager', 'str'), - ('instance_group', 'str'), ] TL_ALL_PARAMETERS_DS = [ + 'instance_group', 'name', 'instance_group_manager', - 'instance_group', ] TL_CONFLICTS_MAP = { - 'membership_count': ['target_manager', 'max_membership_count', 'min_membership_count'], - 'max_membership_count': ['membership_count'], 'target_manager': ['membership_count'], 'cron_spec': ['run_at'], + 'membership_count': ['target_manager', 'max_membership_count', 'min_membership_count'], 'min_membership_count': ['membership_count'], 'run_at': ['cron_spec'], + 'max_membership_count': ['membership_count'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance_group=dict( + name=dict( required=False, type='str'), - membership_count=dict( - required=False, - type='int'), - max_membership_count=dict( - required=False, - type='int'), target_manager=dict( required=False, type='str'), cron_spec=dict( required=False, type='str'), - name=dict( + membership_count=dict( + required=False, + type='int'), + instance_group_manager=dict( required=False, type='str'), min_membership_count=dict( required=False, type='int'), - instance_group_manager=dict( + instance_group=dict( required=False, type='str'), run_at=dict( required=False, type='str'), + max_membership_count=dict( + required=False, + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_instance_group_manager_action_info.py b/plugins/modules/ibm_is_instance_group_manager_action_info.py index d9e54c36a..b8a644639 100644 --- a/plugins/modules/ibm_is_instance_group_manager_action_info.py +++ b/plugins/modules/ibm_is_instance_group_manager_action_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + instance_group: + description: + - instance group ID + required: True + type: str name: description: - instance group manager action name @@ -31,11 +36,6 @@ - Instance group manager ID of type scheduled required: True type: str - instance_group: - description: - - instance group ID - required: True - type: str generation: description: - The generation of Virtual Private Cloud infrastructure @@ -69,16 +69,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('instance_group', 'str'), ('name', 'str'), ('instance_group_manager', 'str'), - ('instance_group', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'instance_group', 'name', 'instance_group_manager', - 'instance_group', ] @@ -89,13 +89,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + instance_group=dict( required=True, type='str'), - instance_group_manager=dict( + name=dict( required=True, type='str'), - instance_group=dict( + instance_group_manager=dict( required=True, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_instance_group_manager_actions_info.py b/plugins/modules/ibm_is_instance_group_manager_actions_info.py index e9b1e6880..c032c1ab2 100644 --- a/plugins/modules/ibm_is_instance_group_manager_actions_info.py +++ b/plugins/modules/ibm_is_instance_group_manager_actions_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - instance_group: + instance_group_manager: description: - - instance group ID + - Instance group manager ID required: True type: str - instance_group_manager: + instance_group: description: - - Instance group manager ID + - instance group ID required: True type: str generation: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('instance_group', 'str'), ('instance_group_manager', 'str'), + ('instance_group', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'instance_group', 'instance_group_manager', + 'instance_group', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance_group=dict( + instance_group_manager=dict( required=True, type='str'), - instance_group_manager=dict( + instance_group=dict( required=True, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_instance_group_manager_policy.py b/plugins/modules/ibm_is_instance_group_manager_policy.py index d973caa64..112c434c1 100644 --- a/plugins/modules/ibm_is_instance_group_manager_policy.py +++ b/plugins/modules/ibm_is_instance_group_manager_policy.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + policy_type: + description: + - (Required for new resource) The type of Policy for the Instance Group + required: True + type: str name: description: - instance group manager policy name @@ -47,11 +52,6 @@ - (Required for new resource) The metric value to be evaluated required: True type: int - policy_type: - description: - - (Required for new resource) The type of Policy for the Instance Group - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -98,21 +98,21 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('policy_type', 'str'), ('instance_group', 'str'), ('instance_group_manager', 'str'), ('metric_type', 'str'), ('metric_value', 'int'), - ('policy_type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'policy_type', 'name', 'instance_group', 'instance_group_manager', 'metric_type', 'metric_value', - 'policy_type', ] # Params for Data source @@ -135,6 +135,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + policy_type=dict( + required=False, + type='str'), name=dict( required=False, type='str'), @@ -150,9 +153,6 @@ metric_value=dict( required=False, type='int'), - policy_type=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_instance_group_membership.py b/plugins/modules/ibm_is_instance_group_membership.py index 1d00dad0c..9e94e67f9 100644 --- a/plugins/modules/ibm_is_instance_group_membership.py +++ b/plugins/modules/ibm_is_instance_group_membership.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - instance_group: - description: - - (Required for new resource) The instance group identifier. - required: True - type: str name: description: - The user-defined name for this instance group membership. Names must be unique within the instance group. @@ -38,6 +33,11 @@ required: False type: bool default: False + instance_group: + description: + - (Required for new resource) The instance group identifier. + required: True + type: str instance_group_membership: description: - (Required for new resource) The unique identifier for this instance group membership. @@ -95,9 +95,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'instance_group', 'name', 'action_delete', + 'instance_group', 'instance_group_membership', ] @@ -119,15 +119,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance_group=dict( - required=False, - type='str'), name=dict( required=False, type='str'), action_delete=dict( required=False, type='bool'), + instance_group=dict( + required=False, + type='str'), instance_group_membership=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_instance_info.py b/plugins/modules/ibm_is_instance_info.py index cb2adda74..6dc834b70 100644 --- a/plugins/modules/ibm_is_instance_info.py +++ b/plugins/modules/ibm_is_instance_info.py @@ -21,9 +21,9 @@ - Terraform v0.12.20 options: - private_key: + passphrase: description: - - Instance Private Key file + - Passphrase for Instance Private Key file required: False type: str name: @@ -31,9 +31,9 @@ - Instance name required: True type: str - passphrase: + private_key: description: - - Passphrase for Instance Private Key file + - Instance Private Key file required: False type: str generation: @@ -74,9 +74,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'private_key', - 'name', 'passphrase', + 'name', + 'private_key', ] @@ -87,13 +87,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - private_key=dict( + passphrase=dict( required=False, type='str'), name=dict( required=True, type='str'), - passphrase=dict( + private_key=dict( required=False, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_instance_network_interface.py b/plugins/modules/ibm_is_instance_network_interface.py index ba5ad8a68..74294c3c1 100644 --- a/plugins/modules/ibm_is_instance_network_interface.py +++ b/plugins/modules/ibm_is_instance_network_interface.py @@ -22,30 +22,20 @@ - Terraform v0.12.20 options: - primary_ipv4_address: + floating_ip: description: - - The primary IPv4 address. If specified, it must be an available address on the network interface's subnet. If unspecified, an available address on the subnet will be automatically selected. + - The ID of the floating IP to attach to this network interface required: False type: str - subnet: - description: - - (Required for new resource) The unique identifier of the subnet. - required: True - type: str allow_ip_spoofing: description: - Indicates whether source IP spoofing is allowed on this interface. If false, source IP spoofing is prevented on this interface. If true, source IP spoofing is allowed on this interface. required: False type: bool default: False - name: - description: - - (Required for new resource) The user-defined name for this network interface. If unspecified, the name will be a hyphenated list of randomly-selected words. - required: True - type: str - floating_ip: + primary_ipv4_address: description: - - The ID of the floating IP to attach to this network interface + - The primary IPv4 address. If specified, it must be an available address on the network interface's subnet. If unspecified, an available address on the subnet will be automatically selected. required: False type: str instance: @@ -53,6 +43,16 @@ - (Required for new resource) The unique identifier of the instance. required: True type: str + name: + description: + - (Required for new resource) The user-defined name for this network interface. If unspecified, the name will be a hyphenated list of randomly-selected words. + required: True + type: str + subnet: + description: + - (Required for new resource) The unique identifier of the subnet. + required: True + type: str security_groups: description: - None @@ -105,31 +105,31 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('subnet', 'str'), - ('name', 'str'), ('instance', 'str'), + ('name', 'str'), + ('subnet', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'primary_ipv4_address', - 'subnet', - 'allow_ip_spoofing', - 'name', 'floating_ip', + 'allow_ip_spoofing', + 'primary_ipv4_address', 'instance', + 'name', + 'subnet', 'security_groups', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('network_interface_name', 'str'), ('instance_name', 'str'), + ('network_interface_name', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'network_interface_name', 'instance_name', + 'network_interface_name', ] TL_CONFLICTS_MAP = { @@ -139,22 +139,22 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - primary_ipv4_address=dict( - required=False, - type='str'), - subnet=dict( + floating_ip=dict( required=False, type='str'), allow_ip_spoofing=dict( required=False, type='bool'), - name=dict( + primary_ipv4_address=dict( required=False, type='str'), - floating_ip=dict( + instance=dict( required=False, type='str'), - instance=dict( + name=dict( + required=False, + type='str'), + subnet=dict( required=False, type='str'), security_groups=dict( diff --git a/plugins/modules/ibm_is_instance_network_interface_info.py b/plugins/modules/ibm_is_instance_network_interface_info.py index 2cf34900c..0b3256c57 100644 --- a/plugins/modules/ibm_is_instance_network_interface_info.py +++ b/plugins/modules/ibm_is_instance_network_interface_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - network_interface_name: + instance_name: description: - - The network interface name. + - The instance name. required: True type: str - instance_name: + network_interface_name: description: - - The instance name. + - The network interface name. required: True type: str generation: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('network_interface_name', 'str'), ('instance_name', 'str'), + ('network_interface_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'network_interface_name', 'instance_name', + 'network_interface_name', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - network_interface_name=dict( + instance_name=dict( required=True, type='str'), - instance_name=dict( + network_interface_name=dict( required=True, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_instance_template.py b/plugins/modules/ibm_is_instance_template.py index e87ba4b4f..c06da1c6e 100644 --- a/plugins/modules/ibm_is_instance_template.py +++ b/plugins/modules/ibm_is_instance_template.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - profile: - description: - - (Required for new resource) Profile info - required: True - type: str dedicated_host_group: description: - Unique Identifier of the Dedicated Host Group where the instance will be placed @@ -37,76 +32,81 @@ - Unique Identifier of the Placement Group for restricting the placement of the instance required: False type: str - volume_attachments: - description: - - None - required: False - type: list - elements: dict - network_interfaces: + boot_volume: description: - None required: False type: list elements: dict - boot_volume: + name: description: - - None + - Instance Template name required: False - type: list - elements: dict - vpc: + type: str + zone: description: - - (Required for new resource) VPC id + - (Required for new resource) Zone name required: True type: str + total_volume_bandwidth: + description: + - The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes + required: False + type: int keys: description: - (Required for new resource) SSH key Ids for the instance template required: True type: list elements: str - dedicated_host: + user_data: description: - - Unique Identifier of the Dedicated Host where the instance will be placed + - User data given for the instance required: False type: str - primary_network_interface: - description: - - (Required for new resource) Primary Network interface info - required: True - type: list - elements: dict - total_volume_bandwidth: + resource_group: description: - - The amount of bandwidth (in megabits per second) allocated exclusively to instance storage volumes + - Instance template resource group required: False - type: int - zone: + type: str + image: description: - - (Required for new resource) Zone name + - (Required for new resource) image name required: True type: str - name: + vpc: description: - - Instance Template name - required: False + - (Required for new resource) VPC id + required: True type: str - image: + profile: description: - - (Required for new resource) image name + - (Required for new resource) Profile info required: True type: str - resource_group: + primary_network_interface: description: - - Instance template resource group + - (Required for new resource) Primary Network interface info + required: True + type: list + elements: dict + dedicated_host: + description: + - Unique Identifier of the Dedicated Host where the instance will be placed required: False type: str - user_data: + volume_attachments: description: - - User data given for the instance + - None required: False - type: str + type: list + elements: dict + network_interfaces: + description: + - None + required: False + type: list + elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -153,32 +153,32 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('profile', 'str'), - ('vpc', 'str'), - ('keys', 'list'), - ('primary_network_interface', 'list'), ('zone', 'str'), + ('keys', 'list'), ('image', 'str'), + ('vpc', 'str'), + ('profile', 'str'), + ('primary_network_interface', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'profile', 'dedicated_host_group', 'placement_group', - 'volume_attachments', - 'network_interfaces', 'boot_volume', - 'vpc', - 'keys', - 'dedicated_host', - 'primary_network_interface', - 'total_volume_bandwidth', - 'zone', 'name', - 'image', - 'resource_group', + 'zone', + 'total_volume_bandwidth', + 'keys', 'user_data', + 'resource_group', + 'image', + 'vpc', + 'profile', + 'primary_network_interface', + 'dedicated_host', + 'volume_attachments', + 'network_interfaces', ] # Params for Data source @@ -186,8 +186,8 @@ ] TL_ALL_PARAMETERS_DS = [ - 'name', 'identifier', + 'name', ] TL_CONFLICTS_MAP = { @@ -200,59 +200,59 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - profile=dict( - required=False, - type='str'), dedicated_host_group=dict( required=False, type='str'), placement_group=dict( required=False, type='str'), - volume_attachments=dict( - required=False, - elements='', - type='list'), - network_interfaces=dict( - required=False, - elements='', - type='list'), boot_volume=dict( required=False, elements='', type='list'), - vpc=dict( + name=dict( required=False, type='str'), - keys=dict( - required=False, - elements='', - type='list'), - dedicated_host=dict( + zone=dict( required=False, type='str'), - primary_network_interface=dict( - required=False, - elements='', - type='list'), total_volume_bandwidth=dict( required=False, type='int'), - zone=dict( + keys=dict( + required=False, + elements='', + type='list'), + user_data=dict( required=False, type='str'), - name=dict( + resource_group=dict( required=False, type='str'), image=dict( required=False, type='str'), - resource_group=dict( + vpc=dict( required=False, type='str'), - user_data=dict( + profile=dict( + required=False, + type='str'), + primary_network_interface=dict( + required=False, + elements='', + type='list'), + dedicated_host=dict( required=False, type='str'), + volume_attachments=dict( + required=False, + elements='', + type='list'), + network_interfaces=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_instance_template_info.py b/plugins/modules/ibm_is_instance_template_info.py index 6d3418d46..1a7cfedb6 100644 --- a/plugins/modules/ibm_is_instance_template_info.py +++ b/plugins/modules/ibm_is_instance_template_info.py @@ -21,12 +21,12 @@ - Terraform v0.12.20 options: - name: + identifier: description: - None required: False type: str - identifier: + name: description: - None required: False @@ -68,8 +68,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'identifier', + 'name', ] @@ -80,10 +80,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + identifier=dict( required=False, type='str'), - identifier=dict( + name=dict( required=False, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_instance_volume_attachment.py b/plugins/modules/ibm_is_instance_volume_attachment.py index 009105f3c..4c94d29cd 100644 --- a/plugins/modules/ibm_is_instance_volume_attachment.py +++ b/plugins/modules/ibm_is_instance_volume_attachment.py @@ -22,16 +22,21 @@ - Terraform v0.12.20 options: - instance: - description: - - (Required for new resource) Instance id - required: True - type: str name: description: - The user-defined name for this volume attachment. required: False type: str + iops: + description: + - The maximum I/O operations per second (IOPS) for the volume. + required: False + type: int + instance: + description: + - (Required for new resource) Instance id + required: True + type: str volume: description: - Instance id @@ -42,42 +47,37 @@ - The unique user-defined name for this volume required: False type: str - encryption_key: + profile: description: - - The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource. + - The globally unique name for the volume profile to use for this volume. required: False type: str - iops: - description: - - The maximum I/O operations per second (IOPS) for the volume. - required: False - type: int - delete_volume_on_instance_delete: + snapshot: description: - - If set to true, when deleting the instance the volume will also be deleted. + - The snapshot of the volume to be attached required: False - type: bool + type: str delete_volume_on_attachment_delete: description: - If set to true, when deleting the attachment, the volume will also be deleted. Default value for this true. required: False type: bool default: True - snapshot: + capacity: description: - - The snapshot of the volume to be attached + - The capacity of the volume in gigabytes. The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. required: False - type: str - profile: + type: int + delete_volume_on_instance_delete: description: - - The globally unique name for the volume profile to use for this volume. + - If set to true, when deleting the instance the volume will also be deleted. required: False - type: str - capacity: + type: bool + encryption_key: description: - - The capacity of the volume in gigabytes. The specified minimum and maximum capacity values for creating or updating volumes may expand in the future. + - The CRN of the [Key Protect Root Key](https://cloud.ibm.com/docs/key-protect?topic=key-protect-getting-started-tutorial) or [Hyper Protect Crypto Service Root Key](https://cloud.ibm.com/docs/hs-crypto?topic=hs-crypto-get-started) for this resource. required: False - type: int + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -129,35 +129,35 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'instance', 'name', + 'iops', + 'instance', 'volume', 'volume_name', - 'encryption_key', - 'iops', - 'delete_volume_on_instance_delete', - 'delete_volume_on_attachment_delete', - 'snapshot', 'profile', + 'snapshot', + 'delete_volume_on_attachment_delete', 'capacity', + 'delete_volume_on_instance_delete', + 'encryption_key', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('instance', 'str'), ('name', 'str'), + ('instance', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'instance', 'name', + 'instance', ] TL_CONFLICTS_MAP = { - 'volume': ['iops', 'volume_name', 'profile', 'capacity', 'snapshot'], 'iops': ['volume'], - 'snapshot': ['volume'], + 'volume': ['iops', 'volume_name', 'profile', 'capacity', 'snapshot'], 'profile': ['volume'], + 'snapshot': ['volume'], 'capacity': ['volume'], } @@ -165,10 +165,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance=dict( + name=dict( required=False, type='str'), - name=dict( + iops=dict( + required=False, + type='int'), + instance=dict( required=False, type='str'), volume=dict( @@ -177,27 +180,24 @@ volume_name=dict( required=False, type='str'), - encryption_key=dict( + profile=dict( required=False, type='str'), - iops=dict( - required=False, - type='int'), - delete_volume_on_instance_delete=dict( - required=False, - type='bool'), - delete_volume_on_attachment_delete=dict( - required=False, - type='bool'), snapshot=dict( required=False, type='str'), - profile=dict( + delete_volume_on_attachment_delete=dict( required=False, - type='str'), + type='bool'), capacity=dict( required=False, type='int'), + delete_volume_on_instance_delete=dict( + required=False, + type='bool'), + encryption_key=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_instance_volume_attachment_info.py b/plugins/modules/ibm_is_instance_volume_attachment_info.py index 094e572a8..18a0d1efc 100644 --- a/plugins/modules/ibm_is_instance_volume_attachment_info.py +++ b/plugins/modules/ibm_is_instance_volume_attachment_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - instance: + name: description: - - Instance id + - The user-defined name for this volume attachment. required: True type: str - name: + instance: description: - - The user-defined name for this volume attachment. + - Instance id required: True type: str generation: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('instance', 'str'), ('name', 'str'), + ('instance', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'instance', 'name', + 'instance', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance=dict( + name=dict( required=True, type='str'), - name=dict( + instance=dict( required=True, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_instances_info.py b/plugins/modules/ibm_is_instances_info.py index 43e24098a..4cbb894f7 100644 --- a/plugins/modules/ibm_is_instances_info.py +++ b/plugins/modules/ibm_is_instances_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - vpc_name: + vpc: description: - - Name of the vpc to filter the instances attached to it + - VPC ID to filter the instances attached to it required: False type: str - vpc: + placement_group: description: - - VPC ID to filter the instances attached to it + - ID of the placement group to filter the instances attached to it required: False type: str vpc_crn: @@ -36,11 +36,21 @@ - VPC CRN to filter the instances attached to it required: False type: str + resource_group: + description: + - Instance resource group + required: False + type: str dedicated_host_name: description: - Name of the dedicated host to filter the instances attached to it required: False type: str + dedicated_host: + description: + - ID of the dedicated host to filter the instances attached to it + required: False + type: str placement_group_name: description: - Name of the placement group to filter the instances attached to it @@ -56,19 +66,9 @@ - Instance group name to filter the instances attached to it required: False type: str - resource_group: - description: - - Instance resource group - required: False - type: str - dedicated_host: - description: - - ID of the dedicated host to filter the instances attached to it - required: False - type: str - placement_group: + vpc_name: description: - - ID of the placement group to filter the instances attached to it + - Name of the vpc to filter the instances attached to it required: False type: str generation: @@ -108,63 +108,63 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'vpc_name', 'vpc', + 'placement_group', 'vpc_crn', + 'resource_group', 'dedicated_host_name', + 'dedicated_host', 'placement_group_name', 'instance_group', 'instance_group_name', - 'resource_group', - 'dedicated_host', - 'placement_group', + 'vpc_name', ] TL_CONFLICTS_MAP = { - 'vpc_name': ['vpc', 'vpc_crn', 'instance_group'], 'vpc': ['vpc_name', 'vpc_crn', 'instance_group'], + 'placement_group': ['placement_group_name'], 'vpc_crn': ['vpc_name', 'vpc', 'instance_group'], 'dedicated_host_name': ['dedicated_host'], + 'dedicated_host': ['dedicated_host_name'], 'placement_group_name': ['placement_group'], 'instance_group': ['vpc', 'vpc_crn', 'vpc_name', 'instance_group_name'], 'instance_group_name': ['vpc', 'vpc_crn', 'vpc_name', 'instance_group'], - 'dedicated_host': ['dedicated_host_name'], - 'placement_group': ['placement_group_name'], + 'vpc_name': ['vpc', 'vpc_crn', 'instance_group'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - vpc_name=dict( + vpc=dict( required=False, type='str'), - vpc=dict( + placement_group=dict( required=False, type='str'), vpc_crn=dict( required=False, type='str'), - dedicated_host_name=dict( + resource_group=dict( required=False, type='str'), - placement_group_name=dict( + dedicated_host_name=dict( required=False, type='str'), - instance_group=dict( + dedicated_host=dict( required=False, type='str'), - instance_group_name=dict( + placement_group_name=dict( required=False, type='str'), - resource_group=dict( + instance_group=dict( required=False, type='str'), - dedicated_host=dict( + instance_group_name=dict( required=False, type='str'), - placement_group=dict( + vpc_name=dict( required=False, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_ipsec_policy.py b/plugins/modules/ibm_is_ipsec_policy.py index fb41462d0..494b43213 100644 --- a/plugins/modules/ibm_is_ipsec_policy.py +++ b/plugins/modules/ibm_is_ipsec_policy.py @@ -22,14 +22,9 @@ - Terraform v0.12.20 options: - name: - description: - - (Required for new resource) IPSEC name - required: True - type: str - authentication_algorithm: + encryption_algorithm: description: - - (Required for new resource) Authentication alorothm + - (Required for new resource) Encryption algorithm required: True type: str pfs: @@ -48,9 +43,14 @@ required: False type: int default: 3600 - encryption_algorithm: + name: description: - - (Required for new resource) Encryption algorithm + - (Required for new resource) IPSEC name + required: True + type: str + authentication_algorithm: + description: + - (Required for new resource) Authentication alorothm required: True type: str id: @@ -99,20 +99,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('encryption_algorithm', 'str'), + ('pfs', 'str'), ('name', 'str'), ('authentication_algorithm', 'str'), - ('pfs', 'str'), - ('encryption_algorithm', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', - 'authentication_algorithm', + 'encryption_algorithm', 'pfs', 'resource_group', 'key_lifetime', - 'encryption_algorithm', + 'name', + 'authentication_algorithm', ] # Params for Data source @@ -129,10 +129,7 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=False, - type='str'), - authentication_algorithm=dict( + encryption_algorithm=dict( required=False, type='str'), pfs=dict( @@ -144,7 +141,10 @@ key_lifetime=dict( required=False, type='int'), - encryption_algorithm=dict( + name=dict( + required=False, + type='str'), + authentication_algorithm=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_is_lb.py b/plugins/modules/ibm_is_lb.py index 530ade1d4..9239cc151 100644 --- a/plugins/modules/ibm_is_lb.py +++ b/plugins/modules/ibm_is_lb.py @@ -32,47 +32,47 @@ - None required: False type: str + route_mode: + description: + - Indicates whether route mode is enabled for this load balancer + required: False + type: bool + default: False subnets: description: - (Required for new resource) Load Balancer subnets list required: True type: list elements: str - type: - description: - - Load Balancer type - required: False - type: str - default: public tags: description: - None required: False type: list elements: str - route_mode: + profile: description: - - Indicates whether route mode is enabled for this load balancer + - The profile to use for this load balancer. required: False - type: bool - default: False + type: str logging: description: - Logging of Load Balancer required: False type: bool default: False + type: + description: + - Load Balancer type + required: False + type: str + default: public security_groups: description: - Load Balancer securitygroups list required: False type: list elements: str - profile: - description: - - The profile to use for this load balancer. - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -127,13 +127,13 @@ TL_ALL_PARAMETERS = [ 'name', 'resource_group', + 'route_mode', 'subnets', - 'type', 'tags', - 'route_mode', + 'profile', 'logging', + 'type', 'security_groups', - 'profile', ] # Params for Data source @@ -146,9 +146,9 @@ ] TL_CONFLICTS_MAP = { + 'profile': ['logging'], 'logging': ['profile'], 'security_groups': ['profile'], - 'profile': ['logging'], } # define available arguments/parameters a user can pass to the module @@ -161,30 +161,30 @@ resource_group=dict( required=False, type='str'), + route_mode=dict( + required=False, + type='bool'), subnets=dict( required=False, elements='', type='list'), - type=dict( - required=False, - type='str'), tags=dict( required=False, elements='', type='list'), - route_mode=dict( + profile=dict( required=False, - type='bool'), + type='str'), logging=dict( required=False, type='bool'), + type=dict( + required=False, + type='str'), security_groups=dict( required=False, elements='', type='list'), - profile=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_lb_listener.py b/plugins/modules/ibm_is_lb_listener.py index 4224adf88..e2a3a19a4 100644 --- a/plugins/modules/ibm_is_lb_listener.py +++ b/plugins/modules/ibm_is_lb_listener.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + default_pool: + description: + - Loadbalancer default pool info + required: False + type: str + certificate_instance: + description: + - certificate instance for the Loadbalancer + required: False + type: str accept_proxy_protocol: description: - Listener will forward proxy protocol @@ -32,15 +42,10 @@ - The HTTP status code to be returned in the redirect response required: False type: int - https_redirect_uri: - description: - - Target URI where traffic will be redirected - required: False - type: str - https_redirect_listener: + lb: description: - - ID of the listener that will be set as http redirect target - required: False + - (Required for new resource) Loadbalancer listener ID + required: True type: str port: description: @@ -52,14 +57,14 @@ - (Required for new resource) Loadbalancer protocol required: True type: str - default_pool: + https_redirect_listener: description: - - Loadbalancer default pool info + - ID of the listener that will be set as http redirect target required: False type: str - certificate_instance: + https_redirect_uri: description: - - certificate instance for the Loadbalancer + - Target URI where traffic will be redirected required: False type: str connection_limit: @@ -67,11 +72,6 @@ - Connection limit for Loadbalancer required: False type: int - lb: - description: - - (Required for new resource) Loadbalancer listener ID - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -118,22 +118,22 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('protocol', 'str'), ('lb', 'str'), + ('protocol', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'default_pool', + 'certificate_instance', 'accept_proxy_protocol', 'https_redirect_status_code', - 'https_redirect_uri', - 'https_redirect_listener', + 'lb', 'port', 'protocol', - 'default_pool', - 'certificate_instance', + 'https_redirect_listener', + 'https_redirect_uri', 'connection_limit', - 'lb', ] # Params for Data source @@ -150,16 +150,19 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + default_pool=dict( + required=False, + type='str'), + certificate_instance=dict( + required=False, + type='str'), accept_proxy_protocol=dict( required=False, type='bool'), https_redirect_status_code=dict( required=False, type='int'), - https_redirect_uri=dict( - required=False, - type='str'), - https_redirect_listener=dict( + lb=dict( required=False, type='str'), port=dict( @@ -168,18 +171,15 @@ protocol=dict( required=False, type='str'), - default_pool=dict( + https_redirect_listener=dict( required=False, type='str'), - certificate_instance=dict( + https_redirect_uri=dict( required=False, type='str'), connection_limit=dict( required=False, type='int'), - lb=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_lb_listener_policy.py b/plugins/modules/ibm_is_lb_listener_policy.py index 7e5b7b9a9..db542c98f 100644 --- a/plugins/modules/ibm_is_lb_listener_policy.py +++ b/plugins/modules/ibm_is_lb_listener_policy.py @@ -22,67 +22,67 @@ - Terraform v0.12.20 options: - lb: + name: description: - - (Required for new resource) Load Balancer Listener Policy - required: True + - Policy name + required: False type: str - target_https_redirect_status_code: + target_http_status_code: description: - - The HTTP status code to be returned in the redirect response + - Listener Policy target HTTPS Status code. required: False type: int - target_https_redirect_listener: - description: - - ID of the listener that will be set as http redirect target - required: False - type: str - target_id: + lb: description: - - Listener Policy Target ID - required: False + - (Required for new resource) Load Balancer Listener Policy + required: True type: str listener: description: - (Required for new resource) Listener ID required: True type: str - target_https_redirect_uri: - description: - - Target URI where traffic will be redirected - required: False - type: str priority: description: - (Required for new resource) Listener Policy Priority required: True type: int + rules: + description: + - Policy Rules + required: False + type: list + elements: dict target_url: description: - Policy Target URL required: False type: str - name: + target_id: description: - - Policy name + - Listener Policy Target ID required: False type: str - action: + target_https_redirect_status_code: description: - - (Required for new resource) Policy Action - required: True - type: str - rules: + - The HTTP status code to be returned in the redirect response + required: False + type: int + target_https_redirect_uri: description: - - Policy Rules + - Target URI where traffic will be redirected required: False - type: list - elements: dict - target_http_status_code: + type: str + target_https_redirect_listener: description: - - Listener Policy target HTTPS Status code. + - ID of the listener that will be set as http redirect target required: False - type: int + type: str + action: + description: + - (Required for new resource) Policy Action + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -137,18 +137,18 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'name', + 'target_http_status_code', 'lb', - 'target_https_redirect_status_code', - 'target_https_redirect_listener', - 'target_id', 'listener', - 'target_https_redirect_uri', 'priority', + 'rules', 'target_url', - 'name', + 'target_id', + 'target_https_redirect_status_code', + 'target_https_redirect_uri', + 'target_https_redirect_listener', 'action', - 'rules', - 'target_http_status_code', ] # Params for Data source @@ -165,43 +165,43 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - lb=dict( + name=dict( required=False, type='str'), - target_https_redirect_status_code=dict( + target_http_status_code=dict( required=False, type='int'), - target_https_redirect_listener=dict( - required=False, - type='str'), - target_id=dict( + lb=dict( required=False, type='str'), listener=dict( required=False, type='str'), - target_https_redirect_uri=dict( - required=False, - type='str'), priority=dict( required=False, type='int'), + rules=dict( + required=False, + elements='', + type='list'), target_url=dict( required=False, type='str'), - name=dict( + target_id=dict( required=False, type='str'), - action=dict( + target_https_redirect_status_code=dict( + required=False, + type='int'), + target_https_redirect_uri=dict( required=False, type='str'), - rules=dict( + target_https_redirect_listener=dict( required=False, - elements='', - type='list'), - target_http_status_code=dict( + type='str'), + action=dict( required=False, - type='int'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_lb_listener_policy_rule.py b/plugins/modules/ibm_is_lb_listener_policy_rule.py index f6c0f76f6..4bf4f8408 100644 --- a/plugins/modules/ibm_is_lb_listener_policy_rule.py +++ b/plugins/modules/ibm_is_lb_listener_policy_rule.py @@ -22,24 +22,14 @@ - Terraform v0.12.20 options: - lb: - description: - - (Required for new resource) Loadbalancer ID - required: True - type: str - listener: - description: - - (Required for new resource) Listener ID. - required: True - type: str - condition: + type: description: - - (Required for new resource) Condition info of the rule. + - (Required for new resource) Policy rule type. required: True type: str - type: + value: description: - - (Required for new resource) Policy rule type. + - (Required for new resource) policy rule value info required: True type: str policy: @@ -47,9 +37,9 @@ - (Required for new resource) Listener Policy ID required: True type: str - value: + condition: description: - - (Required for new resource) policy rule value info + - (Required for new resource) Condition info of the rule. required: True type: str field: @@ -57,6 +47,16 @@ - None required: False type: str + lb: + description: + - (Required for new resource) Loadbalancer ID + required: True + type: str + listener: + description: + - (Required for new resource) Listener ID. + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -103,23 +103,23 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('lb', 'str'), - ('listener', 'str'), - ('condition', 'str'), ('type', 'str'), - ('policy', 'str'), ('value', 'str'), + ('policy', 'str'), + ('condition', 'str'), + ('lb', 'str'), + ('listener', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'lb', - 'listener', - 'condition', 'type', - 'policy', 'value', + 'policy', + 'condition', 'field', + 'lb', + 'listener', ] # Params for Data source @@ -136,25 +136,25 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - lb=dict( + type=dict( required=False, type='str'), - listener=dict( + value=dict( required=False, type='str'), - condition=dict( + policy=dict( required=False, type='str'), - type=dict( + condition=dict( required=False, type='str'), - policy=dict( + field=dict( required=False, type='str'), - value=dict( + lb=dict( required=False, type='str'), - field=dict( + listener=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_is_lb_pool.py b/plugins/modules/ibm_is_lb_pool.py index 3b1eb37d1..44d4c1fab 100644 --- a/plugins/modules/ibm_is_lb_pool.py +++ b/plugins/modules/ibm_is_lb_pool.py @@ -22,16 +22,36 @@ - Terraform v0.12.20 options: + session_persistence_type: + description: + - Load Balancer Pool session persisence type. + required: False + type: str + lb: + description: + - (Required for new resource) Load Balancer ID + required: True + type: str algorithm: description: - (Required for new resource) Load Balancer Pool algorithm required: True type: str + health_retries: + description: + - (Required for new resource) Load Balancer health retry count + required: True + type: int health_type: description: - (Required for new resource) Load Balancer health type required: True type: str + name: + description: + - (Required for new resource) Load Balancer Pool name + required: True + type: str health_monitor_port: description: - Health monitor Port the LB Pool @@ -42,14 +62,9 @@ - Load Balancer Pool session persisence app cookie name. required: False type: str - name: - description: - - (Required for new resource) Load Balancer Pool name - required: True - type: str - lb: + protocol: description: - - (Required for new resource) Load Balancer ID + - (Required for new resource) Load Balancer Protocol required: True type: str health_timeout: @@ -62,31 +77,16 @@ - Health monitor URL of LB Pool required: False type: str - session_persistence_type: - description: - - Load Balancer Pool session persisence type. - required: False - type: str - proxy_protocol: - description: - - PROXY protocol setting for this pool - required: False - type: str - protocol: - description: - - (Required for new resource) Load Balancer Protocol - required: True - type: str health_delay: description: - (Required for new resource) Load Blancer health delay time period required: True type: int - health_retries: + proxy_protocol: description: - - (Required for new resource) Load Balancer health retry count - required: True - type: int + - PROXY protocol setting for this pool + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -133,31 +133,31 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('lb', 'str'), ('algorithm', 'str'), + ('health_retries', 'int'), ('health_type', 'str'), ('name', 'str'), - ('lb', 'str'), - ('health_timeout', 'int'), ('protocol', 'str'), + ('health_timeout', 'int'), ('health_delay', 'int'), - ('health_retries', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'session_persistence_type', + 'lb', 'algorithm', + 'health_retries', 'health_type', + 'name', 'health_monitor_port', 'session_persistence_app_cookie_name', - 'name', - 'lb', + 'protocol', 'health_timeout', 'health_monitor_url', - 'session_persistence_type', - 'proxy_protocol', - 'protocol', 'health_delay', - 'health_retries', + 'proxy_protocol', ] # Params for Data source @@ -174,45 +174,45 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - algorithm=dict( + session_persistence_type=dict( required=False, type='str'), - health_type=dict( + lb=dict( required=False, type='str'), - health_monitor_port=dict( + algorithm=dict( + required=False, + type='str'), + health_retries=dict( required=False, type='int'), - session_persistence_app_cookie_name=dict( + health_type=dict( required=False, type='str'), name=dict( required=False, type='str'), - lb=dict( - required=False, - type='str'), - health_timeout=dict( + health_monitor_port=dict( required=False, type='int'), - health_monitor_url=dict( + session_persistence_app_cookie_name=dict( required=False, type='str'), - session_persistence_type=dict( + protocol=dict( required=False, type='str'), - proxy_protocol=dict( + health_timeout=dict( required=False, - type='str'), - protocol=dict( + type='int'), + health_monitor_url=dict( required=False, type='str'), health_delay=dict( required=False, type='int'), - health_retries=dict( + proxy_protocol=dict( required=False, - type='int'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_lb_pool_member.py b/plugins/modules/ibm_is_lb_pool_member.py index 2ef998846..772b8b29c 100644 --- a/plugins/modules/ibm_is_lb_pool_member.py +++ b/plugins/modules/ibm_is_lb_pool_member.py @@ -22,36 +22,36 @@ - Terraform v0.12.20 options: + pool: + description: + - (Required for new resource) Loadblancer Poold ID + required: True + type: str lb: description: - (Required for new resource) Load balancer ID required: True type: str - target_id: + target_address: description: - - Load balancer pool member target id + - Load balancer pool member target address required: False type: str - weight: + target_id: description: - - Load balcner pool member weight + - Load balancer pool member target id required: False - type: int - pool: - description: - - (Required for new resource) Loadblancer Poold ID - required: True type: str port: description: - (Required for new resource) Load Balancer Pool port required: True type: int - target_address: + weight: description: - - Load balancer pool member target address + - Load balcner pool member weight required: False - type: str + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -98,19 +98,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('lb', 'str'), ('pool', 'str'), + ('lb', 'str'), ('port', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'pool', 'lb', + 'target_address', 'target_id', - 'weight', - 'pool', 'port', - 'target_address', + 'weight', ] # Params for Data source @@ -127,24 +127,24 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - lb=dict( + pool=dict( required=False, type='str'), - target_id=dict( + lb=dict( required=False, type='str'), - weight=dict( + target_address=dict( required=False, - type='int'), - pool=dict( + type='str'), + target_id=dict( required=False, type='str'), port=dict( required=False, type='int'), - target_address=dict( + weight=dict( required=False, - type='str'), + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_network_acl.py b/plugins/modules/ibm_is_network_acl.py index 3147b5552..67ad61a66 100644 --- a/plugins/modules/ibm_is_network_acl.py +++ b/plugins/modules/ibm_is_network_acl.py @@ -22,33 +22,33 @@ - Terraform v0.12.20 options: - vpc: + name: description: - - Network ACL VPC name - required: False + - (Required for new resource) Network ACL name + required: True type: str - resource_group: + tags: description: - - Resource group ID for the network ACL + - List of tags required: False - type: str + type: list + elements: str rules: description: - None required: False type: list elements: dict - name: + vpc: description: - - (Required for new resource) Network ACL name - required: True + - Network ACL VPC name + required: False type: str - tags: + resource_group: description: - - List of tags + - Resource group ID for the network ACL required: False - type: list - elements: str + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -100,11 +100,11 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'vpc', - 'resource_group', - 'rules', 'name', 'tags', + 'rules', + 'vpc', + 'resource_group', ] # Params for Data source @@ -112,8 +112,8 @@ ] TL_ALL_PARAMETERS_DS = [ - 'name', 'vpc_name', + 'name', 'network_acl', ] @@ -124,23 +124,23 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - vpc=dict( + name=dict( required=False, type='str'), - resource_group=dict( + tags=dict( required=False, - type='str'), + elements='', + type='list'), rules=dict( required=False, elements='', type='list'), - name=dict( + vpc=dict( required=False, type='str'), - tags=dict( + resource_group=dict( required=False, - elements='', - type='list'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_network_acl_info.py b/plugins/modules/ibm_is_network_acl_info.py index 853bf194a..b71d03d23 100644 --- a/plugins/modules/ibm_is_network_acl_info.py +++ b/plugins/modules/ibm_is_network_acl_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - name: + vpc_name: description: - - The network acl name. + - The name of the vpc the network acl resides in. required: False type: str - vpc_name: + name: description: - - The name of the vpc the network acl resides in. + - The network acl name. required: False type: str network_acl: @@ -73,8 +73,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'vpc_name', + 'name', 'network_acl', ] @@ -86,10 +86,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + vpc_name=dict( required=False, type='str'), - vpc_name=dict( + name=dict( required=False, type='str'), network_acl=dict( diff --git a/plugins/modules/ibm_is_network_acl_rule.py b/plugins/modules/ibm_is_network_acl_rule.py index 9a25fef72..6dcc0bce4 100644 --- a/plugins/modules/ibm_is_network_acl_rule.py +++ b/plugins/modules/ibm_is_network_acl_rule.py @@ -22,21 +22,12 @@ - Terraform v0.12.20 options: - before: + udp: description: - - The rule that this rule is immediately before. If absent, this is the last rule. + - None required: False - type: str - action: - description: - - (Required for new resource) Whether to allow or deny matching traffic - required: True - type: str - destination: - description: - - (Required for new resource) The destination CIDR block. The CIDR block 0.0.0.0/0 applies to all addresses. - required: True - type: str + type: list + elements: dict direction: description: - (Required for new resource) Direction of traffic to enforce, either inbound or outbound @@ -48,28 +39,37 @@ required: False type: list elements: dict - tcp: + network_acl: description: - - None + - (Required for new resource) Network ACL id + required: True + type: str + name: + description: + - The user-defined name for this rule. Names must be unique within the network ACL the rule resides in. If unspecified, the name will be a hyphenated list of randomly-selected words. required: False - type: list - elements: dict - udp: + type: str + tcp: description: - None required: False type: list elements: dict - network_acl: + destination: description: - - (Required for new resource) Network ACL id + - (Required for new resource) The destination CIDR block. The CIDR block 0.0.0.0/0 applies to all addresses. required: True type: str - name: + before: description: - - The user-defined name for this rule. Names must be unique within the network ACL the rule resides in. If unspecified, the name will be a hyphenated list of randomly-selected words. + - The rule that this rule is immediately before. If absent, this is the last rule. required: False type: str + action: + description: + - (Required for new resource) Whether to allow or deny matching traffic + required: True + type: str source: description: - (Required for new resource) The source CIDR block. The CIDR block 0.0.0.0/0 applies to all addresses. @@ -121,24 +121,24 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('action', 'str'), - ('destination', 'str'), ('direction', 'str'), ('network_acl', 'str'), + ('destination', 'str'), + ('action', 'str'), ('source', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'before', - 'action', - 'destination', + 'udp', 'direction', 'icmp', - 'tcp', - 'udp', 'network_acl', 'name', + 'tcp', + 'destination', + 'before', + 'action', 'source', ] @@ -154,24 +154,19 @@ ] TL_CONFLICTS_MAP = { + 'udp': ['icmp', 'tcp'], 'icmp': ['tcp', 'udp'], 'tcp': ['icmp', 'udp'], - 'udp': ['icmp', 'tcp'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - before=dict( - required=False, - type='str'), - action=dict( - required=False, - type='str'), - destination=dict( + udp=dict( required=False, - type='str'), + elements='', + type='list'), direction=dict( required=False, type='str'), @@ -179,18 +174,23 @@ required=False, elements='', type='list'), + network_acl=dict( + required=False, + type='str'), + name=dict( + required=False, + type='str'), tcp=dict( required=False, elements='', type='list'), - udp=dict( + destination=dict( required=False, - elements='', - type='list'), - network_acl=dict( + type='str'), + before=dict( required=False, type='str'), - name=dict( + action=dict( required=False, type='str'), source=dict( diff --git a/plugins/modules/ibm_is_placement_group.py b/plugins/modules/ibm_is_placement_group.py index 07325a343..68e80b67f 100644 --- a/plugins/modules/ibm_is_placement_group.py +++ b/plugins/modules/ibm_is_placement_group.py @@ -22,10 +22,10 @@ - Terraform v0.12.20 options: - strategy: + resource_group: description: - - (Required for new resource) The strategy for this placement group- `host_spread`: place on different compute hosts- `power_spread`: place on compute hosts that use different power sourcesThe enumerated values for this property may expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the placement group on which the unexpected strategy was encountered. - required: True + - The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. + required: False type: str name: description: @@ -38,17 +38,17 @@ required: False type: list elements: str - resource_group: - description: - - The unique identifier of the resource group to use. If unspecified, the account's [default resourcegroup](https://cloud.ibm.com/apidocs/resource-manager#introduction) is used. - required: False - type: str access_tags: description: - List of access management tags required: False type: list elements: str + strategy: + description: + - (Required for new resource) The strategy for this placement group- `host_spread`: place on different compute hosts- `power_spread`: place on compute hosts that use different power sourcesThe enumerated values for this property may expand in the future. When processing this property, check for and log unknown values. Optionally halt processing and surface the error, or bypass the placement group on which the unexpected strategy was encountered. + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -95,17 +95,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('strategy', 'str'), ('name', 'str'), + ('strategy', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'strategy', + 'resource_group', 'name', 'tags', - 'resource_group', 'access_tags', + 'strategy', ] # Params for Data source @@ -124,7 +124,7 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - strategy=dict( + resource_group=dict( required=False, type='str'), name=dict( @@ -134,13 +134,13 @@ required=False, elements='', type='list'), - resource_group=dict( - required=False, - type='str'), access_tags=dict( required=False, elements='', type='list'), + strategy=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_public_gateway.py b/plugins/modules/ibm_is_public_gateway.py index 6e7a8e804..7e37ebcf8 100644 --- a/plugins/modules/ibm_is_public_gateway.py +++ b/plugins/modules/ibm_is_public_gateway.py @@ -22,14 +22,24 @@ - Terraform v0.12.20 options: + resource_group: + description: + - Public gateway resource group info + required: False + type: str + name: + description: + - (Required for new resource) Name of the Public gateway instance + required: True + type: str floating_ip: description: - None required: False type: dict - vpc: + zone: description: - - (Required for new resource) Public gateway VPC info + - (Required for new resource) Public gateway zone info required: True type: str tags: @@ -38,19 +48,9 @@ required: False type: list elements: str - name: - description: - - (Required for new resource) Name of the Public gateway instance - required: True - type: str - resource_group: - description: - - Public gateway resource group info - required: False - type: str - zone: + vpc: description: - - (Required for new resource) Public gateway zone info + - (Required for new resource) Public gateway VPC info required: True type: str id: @@ -99,19 +99,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('vpc', 'str'), ('name', 'str'), ('zone', 'str'), + ('vpc', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'floating_ip', - 'vpc', - 'tags', - 'name', 'resource_group', + 'name', + 'floating_ip', 'zone', + 'tags', + 'vpc', ] # Params for Data source @@ -131,23 +131,23 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + resource_group=dict( + required=False, + type='str'), + name=dict( + required=False, + type='str'), floating_ip=dict( required=False, type='dict'), - vpc=dict( + zone=dict( required=False, type='str'), tags=dict( required=False, elements='', type='list'), - name=dict( - required=False, - type='str'), - resource_group=dict( - required=False, - type='str'), - zone=dict( + vpc=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_is_security_group.py b/plugins/modules/ibm_is_security_group.py index a003a9376..5d6555f5f 100644 --- a/plugins/modules/ibm_is_security_group.py +++ b/plugins/modules/ibm_is_security_group.py @@ -22,10 +22,10 @@ - Terraform v0.12.20 options: - vpc: + name: description: - - (Required for new resource) Security group's resource group id - required: True + - Security group name + required: False type: str tags: description: @@ -33,16 +33,16 @@ required: False type: list elements: str - name: - description: - - Security group name - required: False - type: str resource_group: description: - Resource Group ID required: False type: str + vpc: + description: + - (Required for new resource) Security group's resource group id + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -94,10 +94,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'vpc', - 'tags', 'name', + 'tags', 'resource_group', + 'vpc', ] # Params for Data source @@ -116,17 +116,17 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - vpc=dict( + name=dict( required=False, type='str'), tags=dict( required=False, elements='', type='list'), - name=dict( + resource_group=dict( required=False, type='str'), - resource_group=dict( + vpc=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_is_security_group_rule.py b/plugins/modules/ibm_is_security_group_rule.py index 534d5b175..e411fbfef 100644 --- a/plugins/modules/ibm_is_security_group_rule.py +++ b/plugins/modules/ibm_is_security_group_rule.py @@ -22,12 +22,16 @@ - Terraform v0.12.20 options: - icmp: + direction: description: - - protocol=icmp + - (Required for new resource) Direction of traffic to enforce, either inbound or outbound + required: True + type: str + remote: + description: + - Security group id: an IP address, a CIDR block, or a single security group identifier required: False - type: list - elements: dict + type: str tcp: description: - protocol=tcp @@ -39,22 +43,18 @@ - (Required for new resource) Security group id required: True type: str - direction: - description: - - (Required for new resource) Direction of traffic to enforce, either inbound or outbound - required: True - type: str - remote: - description: - - Security group id: an IP address, a CIDR block, or a single security group identifier - required: False - type: str ip_version: description: - IP version: ipv4 required: False type: str default: ipv4 + icmp: + description: + - protocol=icmp + required: False + type: list + elements: dict udp: description: - protocol=udp @@ -107,18 +107,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('group', 'str'), ('direction', 'str'), + ('group', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'icmp', - 'tcp', - 'group', 'direction', 'remote', + 'tcp', + 'group', 'ip_version', + 'icmp', 'udp', ] @@ -130,8 +130,8 @@ ] TL_CONFLICTS_MAP = { - 'icmp': ['tcp', 'udp'], 'tcp': ['udp', 'icmp'], + 'icmp': ['tcp', 'udp'], 'udp': ['tcp', 'icmp'], } @@ -139,10 +139,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - icmp=dict( + direction=dict( required=False, - elements='', - type='list'), + type='str'), + remote=dict( + required=False, + type='str'), tcp=dict( required=False, elements='', @@ -150,15 +152,13 @@ group=dict( required=False, type='str'), - direction=dict( - required=False, - type='str'), - remote=dict( - required=False, - type='str'), ip_version=dict( required=False, type='str'), + icmp=dict( + required=False, + elements='', + type='list'), udp=dict( required=False, elements='', diff --git a/plugins/modules/ibm_is_security_group_target.py b/plugins/modules/ibm_is_security_group_target.py index 1dfeb6059..4dd4d86a0 100644 --- a/plugins/modules/ibm_is_security_group_target.py +++ b/plugins/modules/ibm_is_security_group_target.py @@ -90,13 +90,13 @@ # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('security_group', 'str'), ('name', 'str'), + ('security_group', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'security_group', 'name', + 'security_group', ] TL_CONFLICTS_MAP = { diff --git a/plugins/modules/ibm_is_security_group_target_info.py b/plugins/modules/ibm_is_security_group_target_info.py index 9a9df9b81..6c175079a 100644 --- a/plugins/modules/ibm_is_security_group_target_info.py +++ b/plugins/modules/ibm_is_security_group_target_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - security_group: + name: description: - - Security group id + - Security group target name required: True type: str - name: + security_group: description: - - Security group target name + - Security group id required: True type: str generation: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('security_group', 'str'), ('name', 'str'), + ('security_group', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'security_group', 'name', + 'security_group', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - security_group=dict( + name=dict( required=True, type='str'), - name=dict( + security_group=dict( required=True, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_snapshot.py b/plugins/modules/ibm_is_snapshot.py index 011dbf9b7..2fb5133c5 100644 --- a/plugins/modules/ibm_is_snapshot.py +++ b/plugins/modules/ibm_is_snapshot.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + source_volume: + description: + - (Required for new resource) Snapshot source volume + required: True + type: str name: description: - Snapshot name @@ -32,11 +37,6 @@ - Resource group info required: False type: str - source_volume: - description: - - (Required for new resource) Snapshot source volume - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -88,9 +88,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'source_volume', 'name', 'resource_group', - 'source_volume', ] # Params for Data source @@ -109,13 +109,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + source_volume=dict( required=False, type='str'), - resource_group=dict( + name=dict( required=False, type='str'), - source_volume=dict( + resource_group=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_is_ssh_key.py b/plugins/modules/ibm_is_ssh_key.py index 5f351c6e0..10cb39a08 100644 --- a/plugins/modules/ibm_is_ssh_key.py +++ b/plugins/modules/ibm_is_ssh_key.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + resource_group: + description: + - Resource group ID + required: False + type: str + name: + description: + - (Required for new resource) SSH Key name + required: True + type: str tags: description: - List of tags for SSH key @@ -33,16 +43,6 @@ - (Required for new resource) SSH Public key data required: True type: str - resource_group: - description: - - Resource group ID - required: False - type: str - name: - description: - - (Required for new resource) SSH Key name - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -89,16 +89,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('public_key', 'str'), ('name', 'str'), + ('public_key', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'tags', - 'public_key', 'resource_group', 'name', + 'tags', + 'public_key', ] # Params for Data source @@ -118,6 +118,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + resource_group=dict( + required=False, + type='str'), + name=dict( + required=False, + type='str'), tags=dict( required=False, elements='', @@ -125,12 +131,6 @@ public_key=dict( required=False, type='str'), - resource_group=dict( - required=False, - type='str'), - name=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_subnet.py b/plugins/modules/ibm_is_subnet.py index 54a1c0230..c4d249c62 100644 --- a/plugins/modules/ibm_is_subnet.py +++ b/plugins/modules/ibm_is_subnet.py @@ -22,29 +22,20 @@ - Terraform v0.12.20 options: - ipv4_cidr_block: - description: - - IPV4 subnet - CIDR block - required: False - type: str - name: - description: - - (Required for new resource) Subnet name - required: True - type: str network_acl: description: - The network ACL for this subnet required: False type: str - zone: + tags: description: - - (Required for new resource) Subnet zone info - required: True - type: str - routing_table: + - List of tags + required: False + type: list + elements: str + public_gateway: description: - - routing table id that is associated with the subnet + - Public Gateway of the subnet required: False type: str total_ipv4_address_count: @@ -58,15 +49,20 @@ required: False type: str default: ipv4 - tags: + access_tags: description: - - List of tags + - List of access management tags required: False type: list elements: str - public_gateway: + routing_table: description: - - Public Gateway of the subnet + - routing table id that is associated with the subnet + required: False + type: str + ipv4_cidr_block: + description: + - IPV4 subnet - CIDR block required: False type: str vpc: @@ -74,17 +70,21 @@ - (Required for new resource) VPC instance ID required: True type: str - access_tags: - description: - - List of access management tags - required: False - type: list - elements: str resource_group: description: - The resource group for this subnet required: False type: str + name: + description: + - (Required for new resource) Subnet name + required: True + type: str + zone: + description: + - (Required for new resource) Subnet zone info + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -131,25 +131,25 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('vpc', 'str'), ('name', 'str'), ('zone', 'str'), - ('vpc', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'ipv4_cidr_block', - 'name', 'network_acl', - 'zone', - 'routing_table', - 'total_ipv4_address_count', - 'ip_version', 'tags', 'public_gateway', - 'vpc', + 'total_ipv4_address_count', + 'ip_version', 'access_tags', + 'routing_table', + 'ipv4_cidr_block', + 'vpc', 'resource_group', + 'name', + 'zone', ] # Params for Data source @@ -157,32 +157,27 @@ ] TL_ALL_PARAMETERS_DS = [ - 'name', 'identifier', + 'name', ] TL_CONFLICTS_MAP = { - 'ipv4_cidr_block': ['total_ipv4_address_count'], 'total_ipv4_address_count': ['ipv4_cidr_block'], + 'ipv4_cidr_block': ['total_ipv4_address_count'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - ipv4_cidr_block=dict( - required=False, - type='str'), - name=dict( - required=False, - type='str'), network_acl=dict( required=False, type='str'), - zone=dict( + tags=dict( required=False, - type='str'), - routing_table=dict( + elements='', + type='list'), + public_gateway=dict( required=False, type='str'), total_ipv4_address_count=dict( @@ -191,23 +186,28 @@ ip_version=dict( required=False, type='str'), - tags=dict( + access_tags=dict( required=False, elements='', type='list'), - public_gateway=dict( + routing_table=dict( required=False, type='str'), - vpc=dict( + ipv4_cidr_block=dict( required=False, type='str'), - access_tags=dict( + vpc=dict( required=False, - elements='', - type='list'), + type='str'), resource_group=dict( required=False, type='str'), + name=dict( + required=False, + type='str'), + zone=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_subnet_info.py b/plugins/modules/ibm_is_subnet_info.py index 9cd0c8701..2c18cfaab 100644 --- a/plugins/modules/ibm_is_subnet_info.py +++ b/plugins/modules/ibm_is_subnet_info.py @@ -21,12 +21,12 @@ - Terraform v0.12.20 options: - name: + identifier: description: - None required: False type: str - identifier: + name: description: - None required: False @@ -68,8 +68,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'identifier', + 'name', ] @@ -80,10 +80,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + identifier=dict( required=False, type='str'), - identifier=dict( + name=dict( required=False, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_subnet_reserved_ip.py b/plugins/modules/ibm_is_subnet_reserved_ip.py index 90703079b..d40c5052f 100644 --- a/plugins/modules/ibm_is_subnet_reserved_ip.py +++ b/plugins/modules/ibm_is_subnet_reserved_ip.py @@ -27,16 +27,16 @@ - (Required for new resource) The subnet identifier. required: True type: str - auto_delete: - description: - - If set to true, this reserved IP will be automatically deleted - required: False - type: bool target: description: - The unique identifier for target. required: False type: str + auto_delete: + description: + - If set to true, this reserved IP will be automatically deleted + required: False + type: bool name: description: - The user-defined or system-provided name for this reserved IP. @@ -94,8 +94,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'subnet', - 'auto_delete', 'target', + 'auto_delete', 'name', ] @@ -120,12 +120,12 @@ subnet=dict( required=False, type='str'), - auto_delete=dict( - required=False, - type='bool'), target=dict( required=False, type='str'), + auto_delete=dict( + required=False, + type='bool'), name=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_virtual_endpoint_gateway.py b/plugins/modules/ibm_is_virtual_endpoint_gateway.py index f4c490925..43f8eae05 100644 --- a/plugins/modules/ibm_is_virtual_endpoint_gateway.py +++ b/plugins/modules/ibm_is_virtual_endpoint_gateway.py @@ -22,17 +22,6 @@ - Terraform v0.12.20 options: - vpc: - description: - - (Required for new resource) The VPC id - required: True - type: str - ips: - description: - - Endpoint gateway IPs - required: False - type: list - elements: dict target: description: - (Required for new resource) Endpoint gateway target @@ -61,6 +50,17 @@ required: False type: list elements: str + ips: + description: + - Endpoint gateway IPs + required: False + type: list + elements: dict + vpc: + description: + - (Required for new resource) The VPC id + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -107,20 +107,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('vpc', 'str'), ('target', 'list'), ('name', 'str'), + ('vpc', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'vpc', - 'ips', 'target', 'tags', 'name', 'resource_group', 'security_groups', + 'ips', + 'vpc', ] # Params for Data source @@ -139,13 +139,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - vpc=dict( - required=False, - type='str'), - ips=dict( - required=False, - elements='', - type='list'), target=dict( required=False, elements='', @@ -164,6 +157,13 @@ required=False, elements='', type='list'), + ips=dict( + required=False, + elements='', + type='list'), + vpc=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_volume.py b/plugins/modules/ibm_is_volume.py index 8900b5492..2c827006f 100644 --- a/plugins/modules/ibm_is_volume.py +++ b/plugins/modules/ibm_is_volume.py @@ -22,53 +22,53 @@ - Terraform v0.12.20 options: - delete_all_snapshots: - description: - - Deletes all snapshots created from this volume - required: False - type: bool profile: description: - (Required for new resource) Volume profile name required: True type: str - encryption_key: - description: - - Volume encryption key info - required: False - type: str - iops: - description: - - IOPS value for the Volume - required: False - type: int - name: - description: - - (Required for new resource) Volume name - required: True - type: str zone: description: - (Required for new resource) Zone name required: True type: str + tags: + description: + - Tags for the volume instance + required: False + type: list + elements: str capacity: description: - Volume capacity value required: False type: int default: 100 + delete_all_snapshots: + description: + - Deletes all snapshots created from this volume + required: False + type: bool + encryption_key: + description: + - Volume encryption key info + required: False + type: str + name: + description: + - (Required for new resource) Volume name + required: True + type: str resource_group: description: - Resource group name required: False type: str - tags: + iops: description: - - Tags for the volume instance + - IOPS value for the Volume required: False - type: list - elements: str + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -116,21 +116,21 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('profile', 'str'), - ('name', 'str'), ('zone', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'delete_all_snapshots', 'profile', - 'encryption_key', - 'iops', - 'name', 'zone', + 'tags', 'capacity', + 'delete_all_snapshots', + 'encryption_key', + 'name', 'resource_group', - 'tags', + 'iops', ] # Params for Data source @@ -139,8 +139,8 @@ ] TL_ALL_PARAMETERS_DS = [ - 'zone', 'name', + 'zone', ] TL_CONFLICTS_MAP = { @@ -150,34 +150,34 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - delete_all_snapshots=dict( - required=False, - type='bool'), profile=dict( required=False, type='str'), - encryption_key=dict( + zone=dict( required=False, type='str'), - iops=dict( + tags=dict( + required=False, + elements='', + type='list'), + capacity=dict( required=False, type='int'), - name=dict( + delete_all_snapshots=dict( required=False, - type='str'), - zone=dict( + type='bool'), + encryption_key=dict( required=False, type='str'), - capacity=dict( + name=dict( required=False, - type='int'), + type='str'), resource_group=dict( required=False, type='str'), - tags=dict( + iops=dict( required=False, - elements='', - type='list'), + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_volume_info.py b/plugins/modules/ibm_is_volume_info.py index b8da2ee59..d85756bc1 100644 --- a/plugins/modules/ibm_is_volume_info.py +++ b/plugins/modules/ibm_is_volume_info.py @@ -21,16 +21,16 @@ - Terraform v0.12.20 options: - zone: - description: - - Zone name - required: False - type: str name: description: - Volume name required: True type: str + zone: + description: + - Zone name + required: False + type: str generation: description: - The generation of Virtual Private Cloud infrastructure @@ -69,8 +69,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'zone', 'name', + 'zone', ] @@ -81,12 +81,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - zone=dict( - required=False, - type='str'), name=dict( required=True, type='str'), + zone=dict( + required=False, + type='str'), generation=dict( type='int', required=False, diff --git a/plugins/modules/ibm_is_vpc.py b/plugins/modules/ibm_is_vpc.py index 00cb34945..6353db726 100644 --- a/plugins/modules/ibm_is_vpc.py +++ b/plugins/modules/ibm_is_vpc.py @@ -22,49 +22,49 @@ - Terraform v0.12.20 options: - address_prefix_management: + resource_group: description: - - Address Prefix management value + - Resource group info required: False type: str - default: auto - default_network_acl_name: + address_prefix_management: description: - - Default Network ACL name + - Address Prefix management value required: False type: str - default_security_group_name: + default: auto + classic_access: description: - - Default security group name + - Set to true if classic access needs to enabled to VPC required: False - type: str - default_routing_table_name: + type: bool + default: False + default_network_acl_name: description: - - Default routing table name + - Default Network ACL name required: False type: str - classic_access: + tags: description: - - Set to true if classic access needs to enabled to VPC + - List of tags required: False - type: bool - default: False + type: list + elements: str name: description: - (Required for new resource) VPC name required: True type: str - resource_group: + default_security_group_name: description: - - Resource group info + - Default security group name required: False type: str - tags: + default_routing_table_name: description: - - List of tags + - Default routing table name required: False - type: list - elements: str + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -116,14 +116,14 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'resource_group', 'address_prefix_management', + 'classic_access', 'default_network_acl_name', + 'tags', + 'name', 'default_security_group_name', 'default_routing_table_name', - 'classic_access', - 'name', - 'resource_group', - 'tags', ] # Params for Data source @@ -142,31 +142,31 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - address_prefix_management=dict( + resource_group=dict( required=False, type='str'), - default_network_acl_name=dict( + address_prefix_management=dict( required=False, type='str'), - default_security_group_name=dict( + classic_access=dict( required=False, - type='str'), - default_routing_table_name=dict( + type='bool'), + default_network_acl_name=dict( required=False, type='str'), - classic_access=dict( + tags=dict( required=False, - type='bool'), + elements='', + type='list'), name=dict( required=False, type='str'), - resource_group=dict( + default_security_group_name=dict( required=False, type='str'), - tags=dict( + default_routing_table_name=dict( required=False, - elements='', - type='list'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_vpc_address_prefix.py b/plugins/modules/ibm_is_vpc_address_prefix.py index 32ea80879..dad31f0ba 100644 --- a/plugins/modules/ibm_is_vpc_address_prefix.py +++ b/plugins/modules/ibm_is_vpc_address_prefix.py @@ -22,16 +22,6 @@ - Terraform v0.12.20 options: - name: - description: - - (Required for new resource) Name - required: True - type: str - zone: - description: - - (Required for new resource) Zone name - required: True - type: str cidr: description: - (Required for new resource) CIDIR address prefix @@ -48,6 +38,16 @@ - (Required for new resource) VPC id required: True type: str + name: + description: + - (Required for new resource) Name + required: True + type: str + zone: + description: + - (Required for new resource) Zone name + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -94,19 +94,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), - ('zone', 'str'), ('cidr', 'str'), ('vpc', 'str'), + ('name', 'str'), + ('zone', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', - 'zone', 'cidr', 'is_default', 'vpc', + 'name', + 'zone', ] # Params for Data source @@ -123,12 +123,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=False, - type='str'), - zone=dict( - required=False, - type='str'), cidr=dict( required=False, type='str'), @@ -138,6 +132,12 @@ vpc=dict( required=False, type='str'), + name=dict( + required=False, + type='str'), + zone=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_vpc_address_prefixes_info.py b/plugins/modules/ibm_is_vpc_address_prefixes_info.py index cdc170ae3..cceda18eb 100644 --- a/plugins/modules/ibm_is_vpc_address_prefixes_info.py +++ b/plugins/modules/ibm_is_vpc_address_prefixes_info.py @@ -21,16 +21,16 @@ - Terraform v0.12.20 options: - name: - description: - - The user-defined name for this address prefix. Names must be unique within the VPC the address prefix resides in. - required: False - type: str vpc: description: - The VPC identifier. required: True type: str + name: + description: + - The user-defined name for this address prefix. Names must be unique within the VPC the address prefix resides in. + required: False + type: str generation: description: - The generation of Virtual Private Cloud infrastructure @@ -69,8 +69,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'vpc', + 'name', ] @@ -81,12 +81,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=False, - type='str'), vpc=dict( required=True, type='str'), + name=dict( + required=False, + type='str'), generation=dict( type='int', required=False, diff --git a/plugins/modules/ibm_is_vpc_route.py b/plugins/modules/ibm_is_vpc_route.py index 3c2f00439..dee72e01d 100644 --- a/plugins/modules/ibm_is_vpc_route.py +++ b/plugins/modules/ibm_is_vpc_route.py @@ -22,16 +22,6 @@ - Terraform v0.12.20 options: - vpc: - description: - - (Required for new resource) VPC instance ID - required: True - type: str - next_hop: - description: - - (Required for new resource) VPC route next hop value - required: True - type: str name: description: - (Required for new resource) VPC route name @@ -47,6 +37,16 @@ - (Required for new resource) VPC route destination CIDR value required: True type: str + vpc: + description: + - (Required for new resource) VPC instance ID + required: True + type: str + next_hop: + description: + - (Required for new resource) VPC route next hop value + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -93,20 +93,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('vpc', 'str'), - ('next_hop', 'str'), ('name', 'str'), ('zone', 'str'), ('destination', 'str'), + ('vpc', 'str'), + ('next_hop', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'vpc', - 'next_hop', 'name', 'zone', 'destination', + 'vpc', + 'next_hop', ] # Params for Data source @@ -123,19 +123,19 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - vpc=dict( + name=dict( required=False, type='str'), - next_hop=dict( + zone=dict( required=False, type='str'), - name=dict( + destination=dict( required=False, type='str'), - zone=dict( + vpc=dict( required=False, type='str'), - destination=dict( + next_hop=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_is_vpc_routing_table.py b/plugins/modules/ibm_is_vpc_routing_table.py index 32a3c595c..f12b7c02e 100644 --- a/plugins/modules/ibm_is_vpc_routing_table.py +++ b/plugins/modules/ibm_is_vpc_routing_table.py @@ -22,26 +22,26 @@ - Terraform v0.12.20 options: - vpc: - description: - - (Required for new resource) The VPC identifier. - required: True - type: str route_direct_link_ingress: description: - If set to true, this routing table will be used to route traffic that originates from Direct Link to this VPC. required: False type: bool default: False - route_transit_gateway_ingress: + route_vpc_zone_ingress: description: - - If set to true, this routing table will be used to route traffic that originates from Transit Gateway to this VPC. + - If set to true, this routing table will be used to route traffic that originates from subnets in other zones in this VPC. required: False type: bool default: False - route_vpc_zone_ingress: + vpc: description: - - If set to true, this routing table will be used to route traffic that originates from subnets in other zones in this VPC. + - (Required for new resource) The VPC identifier. + required: True + type: str + route_transit_gateway_ingress: + description: + - If set to true, this routing table will be used to route traffic that originates from Transit Gateway to this VPC. required: False type: bool default: False @@ -101,10 +101,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'vpc', 'route_direct_link_ingress', - 'route_transit_gateway_ingress', 'route_vpc_zone_ingress', + 'vpc', + 'route_transit_gateway_ingress', 'name', ] @@ -122,16 +122,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - vpc=dict( - required=False, - type='str'), route_direct_link_ingress=dict( required=False, type='bool'), - route_transit_gateway_ingress=dict( + route_vpc_zone_ingress=dict( required=False, type='bool'), - route_vpc_zone_ingress=dict( + vpc=dict( + required=False, + type='str'), + route_transit_gateway_ingress=dict( required=False, type='bool'), name=dict( diff --git a/plugins/modules/ibm_is_vpc_routing_table_route.py b/plugins/modules/ibm_is_vpc_routing_table_route.py index fc507dfe7..5e4577e13 100644 --- a/plugins/modules/ibm_is_vpc_routing_table_route.py +++ b/plugins/modules/ibm_is_vpc_routing_table_route.py @@ -22,6 +22,17 @@ - Terraform v0.12.20 options: + next_hop: + description: + - (Required for new resource) If action is deliver, the next hop that packets will be delivered to. For other action values, its address will be 0.0.0.0. + required: True + type: str + action: + description: + - The action to perform with a packet matching the route. + required: False + type: str + default: deliver vpc: description: - (Required for new resource) The VPC identifier. @@ -37,27 +48,16 @@ - (Required for new resource) The zone to apply the route to. Traffic from subnets in this zone will be subject to this route. required: True type: str - next_hop: + name: description: - - (Required for new resource) If action is deliver, the next hop that packets will be delivered to. For other action values, its address will be 0.0.0.0. - required: True + - The user-defined name for this route. + required: False type: str routing_table: description: - (Required for new resource) The routing table identifier. required: True type: str - action: - description: - - The action to perform with a packet matching the route. - required: False - type: str - default: deliver - name: - description: - - The user-defined name for this route. - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -104,22 +104,22 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('next_hop', 'str'), ('vpc', 'str'), ('destination', 'str'), ('zone', 'str'), - ('next_hop', 'str'), ('routing_table', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'next_hop', + 'action', 'vpc', 'destination', 'zone', - 'next_hop', - 'routing_table', - 'action', 'name', + 'routing_table', ] # Params for Data source @@ -136,25 +136,25 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - vpc=dict( + next_hop=dict( required=False, type='str'), - destination=dict( + action=dict( required=False, type='str'), - zone=dict( + vpc=dict( required=False, type='str'), - next_hop=dict( + destination=dict( required=False, type='str'), - routing_table=dict( + zone=dict( required=False, type='str'), - action=dict( + name=dict( required=False, type='str'), - name=dict( + routing_table=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_is_vpn_gateway.py b/plugins/modules/ibm_is_vpn_gateway.py index 31743b528..d33a7c57c 100644 --- a/plugins/modules/ibm_is_vpn_gateway.py +++ b/plugins/modules/ibm_is_vpn_gateway.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + subnet: + description: + - (Required for new resource) VPNGateway subnet info + required: True + type: str + name: + description: + - (Required for new resource) VPN Gateway instance name + required: True + type: str tags: description: - VPN Gateway tags list @@ -34,16 +44,6 @@ required: False type: str default: route - name: - description: - - (Required for new resource) VPN Gateway instance name - required: True - type: str - subnet: - description: - - (Required for new resource) VPNGateway subnet info - required: True - type: str resource_group: description: - The resource group for this VPN gateway @@ -95,16 +95,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('subnet', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'subnet', + 'name', 'tags', 'mode', - 'name', - 'subnet', 'resource_group', ] @@ -122,17 +122,17 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - tags=dict( - required=False, - elements='', - type='list'), - mode=dict( + subnet=dict( required=False, type='str'), name=dict( required=False, type='str'), - subnet=dict( + tags=dict( + required=False, + elements='', + type='list'), + mode=dict( required=False, type='str'), resource_group=dict( diff --git a/plugins/modules/ibm_is_vpn_gateway_connection.py b/plugins/modules/ibm_is_vpn_gateway_connection.py index 96704e96b..08148c653 100644 --- a/plugins/modules/ibm_is_vpn_gateway_connection.py +++ b/plugins/modules/ibm_is_vpn_gateway_connection.py @@ -22,45 +22,11 @@ - Terraform v0.12.20 options: - admin_state_up: - description: - - VPN gateway connection admin state - required: False - type: bool - default: False - local_cidrs: - description: - - VPN gateway connection local CIDRs - required: False - type: list - elements: str name: description: - (Required for new resource) VPN Gateway connection name required: True type: str - vpn_gateway: - description: - - (Required for new resource) VPN Gateway info - required: True - type: str - preshared_key: - description: - - (Required for new resource) vpn gateway - required: True - type: str - peer_cidrs: - description: - - VPN gateway connection peer CIDRs - required: False - type: list - elements: str - interval: - description: - - Interval for dead peer detection interval - required: False - type: int - default: 2 ipsec_policy: description: - IP security policy for vpn gateway connection @@ -71,6 +37,12 @@ - (Required for new resource) VPN gateway connection peer address required: True type: str + admin_state_up: + description: + - VPN gateway connection admin state + required: False + type: bool + default: False action: description: - Action detection for dead peer detection action @@ -88,6 +60,34 @@ - VPN gateway connection IKE Policy required: False type: str + vpn_gateway: + description: + - (Required for new resource) VPN Gateway info + required: True + type: str + preshared_key: + description: + - (Required for new resource) vpn gateway + required: True + type: str + local_cidrs: + description: + - VPN gateway connection local CIDRs + required: False + type: list + elements: str + peer_cidrs: + description: + - VPN gateway connection peer CIDRs + required: False + type: list + elements: str + interval: + description: + - Interval for dead peer detection interval + required: False + type: int + default: 2 id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -135,25 +135,25 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('name', 'str'), + ('peer_address', 'str'), ('vpn_gateway', 'str'), ('preshared_key', 'str'), - ('peer_address', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'admin_state_up', - 'local_cidrs', 'name', - 'vpn_gateway', - 'preshared_key', - 'peer_cidrs', - 'interval', 'ipsec_policy', 'peer_address', + 'admin_state_up', 'action', 'timeout', 'ike_policy', + 'vpn_gateway', + 'preshared_key', + 'local_cidrs', + 'peer_cidrs', + 'interval', ] # Params for Data source @@ -170,14 +170,25 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + name=dict( + required=False, + type='str'), + ipsec_policy=dict( + required=False, + type='str'), + peer_address=dict( + required=False, + type='str'), admin_state_up=dict( required=False, type='bool'), - local_cidrs=dict( + action=dict( required=False, - elements='', - type='list'), - name=dict( + type='str'), + timeout=dict( + required=False, + type='int'), + ike_policy=dict( required=False, type='str'), vpn_gateway=dict( @@ -186,6 +197,10 @@ preshared_key=dict( required=False, type='str'), + local_cidrs=dict( + required=False, + elements='', + type='list'), peer_cidrs=dict( required=False, elements='', @@ -193,21 +208,6 @@ interval=dict( required=False, type='int'), - ipsec_policy=dict( - required=False, - type='str'), - peer_address=dict( - required=False, - type='str'), - action=dict( - required=False, - type='str'), - timeout=dict( - required=False, - type='int'), - ike_policy=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_is_zone_info.py b/plugins/modules/ibm_is_zone_info.py index 413719ce1..d73ab92d0 100644 --- a/plugins/modules/ibm_is_zone_info.py +++ b/plugins/modules/ibm_is_zone_info.py @@ -21,12 +21,12 @@ - Terraform v0.12.20 options: - name: + region_: description: - None required: True type: str - region_: + name: description: - None required: True @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('region_', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'region_', + 'name', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + region_=dict( required=True, type='str'), - region_=dict( + name=dict( required=True, type='str'), generation=dict( diff --git a/plugins/modules/ibm_is_zones_info.py b/plugins/modules/ibm_is_zones_info.py index c041b54fc..87bf515e8 100644 --- a/plugins/modules/ibm_is_zones_info.py +++ b/plugins/modules/ibm_is_zones_info.py @@ -21,15 +21,15 @@ - Terraform v0.12.20 options: - region_: + status: description: - None - required: True + required: False type: str - status: + region_: description: - None - required: False + required: True type: str generation: description: @@ -69,8 +69,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'region_', 'status', + 'region_', ] @@ -81,12 +81,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - region_=dict( - required=True, - type='str'), status=dict( required=False, type='str'), + region_=dict( + required=True, + type='str'), generation=dict( type='int', required=False, diff --git a/plugins/modules/ibm_kms_key.py b/plugins/modules/ibm_kms_key.py index 016151c94..ccab8502c 100644 --- a/plugins/modules/ibm_kms_key.py +++ b/plugins/modules/ibm_kms_key.py @@ -22,20 +22,20 @@ - Terraform v0.12.20 options: - endpoint_type: + key_name: description: - - public or private - required: False + - (Required for new resource) Key name + required: True type: str - force_delete: + standard_key: description: - - set to true to force delete the key + - Standard key type required: False type: bool default: False - expiration_date: + payload: description: - - The date the key material expires. The date format follows RFC 3339. You can set an expiration date on any key on its creation. A key moves into the Deactivated state within one hour past its expiration date, if one is assigned. If you create a key without specifying an expiration date, the key does not expire + - None required: False type: str key_ring_id: @@ -44,33 +44,33 @@ required: False type: str default: default - iv_value: + encrypted_nonce: description: - Only for imported root key required: False type: str - key_name: - description: - - (Required for new resource) Key name - required: True - type: str - instance_id: + endpoint_type: description: - - (Required for new resource) Key protect or hpcs instance GUID or CRN - required: True + - public or private + required: False type: str - standard_key: + force_delete: description: - - Standard key type + - set to true to force delete the key required: False type: bool default: False - payload: + expiration_date: description: - - None + - The date the key material expires. The date format follows RFC 3339. You can set an expiration date on any key on its creation. A key moves into the Deactivated state within one hour past its expiration date, if one is assigned. If you create a key without specifying an expiration date, the key does not expire required: False type: str - encrypted_nonce: + instance_id: + description: + - (Required for new resource) Key protect or hpcs instance GUID or CRN + required: True + type: str + iv_value: description: - Only for imported root key required: False @@ -127,16 +127,16 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'endpoint_type', - 'force_delete', - 'expiration_date', - 'key_ring_id', - 'iv_value', 'key_name', - 'instance_id', 'standard_key', 'payload', + 'key_ring_id', 'encrypted_nonce', + 'endpoint_type', + 'force_delete', + 'expiration_date', + 'instance_id', + 'iv_value', ] # Params for Data source @@ -160,34 +160,34 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - endpoint_type=dict( + key_name=dict( required=False, type='str'), - force_delete=dict( + standard_key=dict( required=False, type='bool'), - expiration_date=dict( + payload=dict( required=False, type='str'), key_ring_id=dict( required=False, type='str'), - iv_value=dict( - required=False, - type='str'), - key_name=dict( + encrypted_nonce=dict( required=False, type='str'), - instance_id=dict( + endpoint_type=dict( required=False, type='str'), - standard_key=dict( + force_delete=dict( required=False, type='bool'), - payload=dict( + expiration_date=dict( required=False, type='str'), - encrypted_nonce=dict( + instance_id=dict( + required=False, + type='str'), + iv_value=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_kms_key_policies.py b/plugins/modules/ibm_kms_key_policies.py index 9e9ca22e1..099143f95 100644 --- a/plugins/modules/ibm_kms_key_policies.py +++ b/plugins/modules/ibm_kms_key_policies.py @@ -116,10 +116,10 @@ ] TL_ALL_PARAMETERS_DS = [ - 'policies', 'instance_id', 'endpoint_type', 'key_id', + 'policies', ] TL_CONFLICTS_MAP = { diff --git a/plugins/modules/ibm_kms_key_policies_info.py b/plugins/modules/ibm_kms_key_policies_info.py index 8c07fafb3..5b0e033a2 100644 --- a/plugins/modules/ibm_kms_key_policies_info.py +++ b/plugins/modules/ibm_kms_key_policies_info.py @@ -21,12 +21,6 @@ - Terraform v0.12.20 options: - policies: - description: - - Creates or updates one or more policies for the specified key - required: False - type: list - elements: dict instance_id: description: - Key protect or hpcs instance GUID @@ -43,6 +37,12 @@ - Key ID of the Key required: True type: str + policies: + description: + - Creates or updates one or more policies for the specified key + required: False + type: list + elements: dict iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -82,10 +82,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'policies', 'instance_id', 'endpoint_type', 'key_id', + 'policies', ] @@ -96,10 +96,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - policies=dict( - required=False, - elements='', - type='list'), instance_id=dict( required=True, type='str'), @@ -109,6 +105,10 @@ key_id=dict( required=True, type='str'), + policies=dict( + required=False, + elements='', + type='list'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_kms_key_rings.py b/plugins/modules/ibm_kms_key_rings.py index b5246ee6f..c71d2a442 100644 --- a/plugins/modules/ibm_kms_key_rings.py +++ b/plugins/modules/ibm_kms_key_rings.py @@ -100,8 +100,8 @@ ] TL_ALL_PARAMETERS_DS = [ - 'instance_id', 'endpoint_type', + 'instance_id', ] TL_CONFLICTS_MAP = { diff --git a/plugins/modules/ibm_kms_key_rings_info.py b/plugins/modules/ibm_kms_key_rings_info.py index 5cacc5609..5592544c3 100644 --- a/plugins/modules/ibm_kms_key_rings_info.py +++ b/plugins/modules/ibm_kms_key_rings_info.py @@ -21,17 +21,17 @@ - Terraform v0.12.20 options: - instance_id: - description: - - Key protect or hpcs instance GUID - required: True - type: str endpoint_type: description: - public or private required: False type: str default: public + instance_id: + description: + - Key protect or hpcs instance GUID + required: True + type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -70,8 +70,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'instance_id', 'endpoint_type', + 'instance_id', ] @@ -82,12 +82,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance_id=dict( - required=True, - type='str'), endpoint_type=dict( required=False, type='str'), + instance_id=dict( + required=True, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_kms_keys_info.py b/plugins/modules/ibm_kms_keys_info.py index 05c287eae..c7327516a 100644 --- a/plugins/modules/ibm_kms_keys_info.py +++ b/plugins/modules/ibm_kms_keys_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + alias: + description: + - The name of the key to be fetched + required: False + type: str key_id: description: - None @@ -47,11 +52,6 @@ - Limit till the keys to be fetched required: False type: int - alias: - description: - - The name of the key to be fetched - required: False - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -90,25 +90,28 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'alias', 'key_id', 'endpoint_type', 'instance_id', 'key_name', 'limit', - 'alias', ] TL_CONFLICTS_MAP = { + 'alias': ['key_name', 'key_id'], 'key_id': ['alias', 'key_name'], 'key_name': ['alias', 'key_id'], - 'alias': ['key_name', 'key_id'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + alias=dict( + required=False, + type='str'), key_id=dict( required=False, type='str'), @@ -124,9 +127,6 @@ limit=dict( required=False, type='int'), - alias=dict( - required=False, - type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_kp_key.py b/plugins/modules/ibm_kp_key.py index 8cb085ea3..fa7285d87 100644 --- a/plugins/modules/ibm_kp_key.py +++ b/plugins/modules/ibm_kp_key.py @@ -27,10 +27,10 @@ - (Required for new resource) Key protect instance ID required: True type: str - key_name: + encrypted_nonce: description: - - (Required for new resource) Key name - required: True + - Only for imported root key + required: False type: str standard_key: description: @@ -38,27 +38,27 @@ required: False type: bool default: False - payload: + key_name: description: - - None - required: False + - (Required for new resource) Key name + required: True type: str iv_value: description: - Only for imported root key required: False type: str + payload: + description: + - None + required: False + type: str force_delete: description: - set to true to force delete the key required: False type: bool default: False - encrypted_nonce: - description: - - Only for imported root key - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -112,12 +112,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'key_protect_id', - 'key_name', + 'encrypted_nonce', 'standard_key', - 'payload', + 'key_name', 'iv_value', + 'payload', 'force_delete', - 'encrypted_nonce', ] # Params for Data source @@ -140,24 +140,24 @@ key_protect_id=dict( required=False, type='str'), - key_name=dict( + encrypted_nonce=dict( required=False, type='str'), standard_key=dict( required=False, type='bool'), - payload=dict( + key_name=dict( required=False, type='str'), iv_value=dict( required=False, type='str'), + payload=dict( + required=False, + type='str'), force_delete=dict( required=False, type='bool'), - encrypted_nonce=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_lb.py b/plugins/modules/ibm_lb.py index 1c895970d..899cd7d8b 100644 --- a/plugins/modules/ibm_lb.py +++ b/plugins/modules/ibm_lb.py @@ -22,14 +22,14 @@ - Terraform v0.12.20 options: - connections: + datacenter: description: - - (Required for new resource) Connections value + - (Required for new resource) Datacenter name info required: True - type: int - ha_enabled: + type: str + dedicated: description: - - true if High availability is enabled + - Boolena value true if Load balncer is dedicated type required: False type: bool default: False @@ -39,22 +39,22 @@ required: False type: list elements: str - datacenter: + connections: description: - - (Required for new resource) Datacenter name info + - (Required for new resource) Connections value required: True - type: str - security_certificate_id: - description: - - Security certificate ID - required: False type: int - dedicated: + ha_enabled: description: - - Boolena value true if Load balncer is dedicated type + - true if High availability is enabled required: False type: bool default: False + security_certificate_id: + description: + - Security certificate ID + required: False + type: int ssl_offload: description: - boolean value true if SSL offload is enabled @@ -107,18 +107,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('connections', 'int'), ('datacenter', 'str'), + ('connections', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'datacenter', + 'dedicated', + 'tags', 'connections', 'ha_enabled', - 'tags', - 'datacenter', 'security_certificate_id', - 'dedicated', 'ssl_offload', ] @@ -136,25 +136,25 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - connections=dict( + datacenter=dict( required=False, - type='int'), - ha_enabled=dict( + type='str'), + dedicated=dict( required=False, type='bool'), tags=dict( required=False, elements='', type='list'), - datacenter=dict( - required=False, - type='str'), - security_certificate_id=dict( + connections=dict( required=False, type='int'), - dedicated=dict( + ha_enabled=dict( required=False, type='bool'), + security_certificate_id=dict( + required=False, + type='int'), ssl_offload=dict( required=False, type='bool'), diff --git a/plugins/modules/ibm_lb_service.py b/plugins/modules/ibm_lb_service.py index edb3837e0..751ac60fe 100644 --- a/plugins/modules/ibm_lb_service.py +++ b/plugins/modules/ibm_lb_service.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + service_group_id: + description: + - (Required for new resource) service group ID + required: True + type: int + ip_address_id: + description: + - (Required for new resource) IP Address ID + required: True + type: int port: description: - (Required for new resource) Port number @@ -48,16 +58,6 @@ required: False type: list elements: str - service_group_id: - description: - - (Required for new resource) service group ID - required: True - type: int - ip_address_id: - description: - - (Required for new resource) IP Address ID - required: True - type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -104,23 +104,23 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('service_group_id', 'int'), + ('ip_address_id', 'int'), ('port', 'int'), ('enabled', 'bool'), ('health_check_type', 'str'), ('weight', 'int'), - ('service_group_id', 'int'), - ('ip_address_id', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'service_group_id', + 'ip_address_id', 'port', 'enabled', 'health_check_type', 'weight', 'tags', - 'service_group_id', - 'ip_address_id', ] # Params for Data source @@ -137,6 +137,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + service_group_id=dict( + required=False, + type='int'), + ip_address_id=dict( + required=False, + type='int'), port=dict( required=False, type='int'), @@ -153,12 +159,6 @@ required=False, elements='', type='list'), - service_group_id=dict( - required=False, - type='int'), - ip_address_id=dict( - required=False, - type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_lb_service_group.py b/plugins/modules/ibm_lb_service_group.py index 9b6851ae4..f62938a8f 100644 --- a/plugins/modules/ibm_lb_service_group.py +++ b/plugins/modules/ibm_lb_service_group.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + load_balancer_id: + description: + - (Required for new resource) Loadbalancer ID + required: True + type: int + routing_method: + description: + - (Required for new resource) Routing method + required: True + type: str routing_type: description: - (Required for new resource) Routing type @@ -43,16 +53,6 @@ - (Required for new resource) Allocation type required: True type: int - routing_method: - description: - - (Required for new resource) Routing method - required: True - type: str - load_balancer_id: - description: - - (Required for new resource) Loadbalancer ID - required: True - type: int port: description: - (Required for new resource) Port number @@ -104,21 +104,21 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('load_balancer_id', 'int'), + ('routing_method', 'str'), ('routing_type', 'str'), ('allocation', 'int'), - ('routing_method', 'str'), - ('load_balancer_id', 'int'), ('port', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'load_balancer_id', + 'routing_method', 'routing_type', 'timeout', 'tags', 'allocation', - 'routing_method', - 'load_balancer_id', 'port', ] @@ -136,6 +136,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + load_balancer_id=dict( + required=False, + type='int'), + routing_method=dict( + required=False, + type='str'), routing_type=dict( required=False, type='str'), @@ -149,12 +155,6 @@ allocation=dict( required=False, type='int'), - routing_method=dict( - required=False, - type='str'), - load_balancer_id=dict( - required=False, - type='int'), port=dict( required=False, type='int'), diff --git a/plugins/modules/ibm_lb_vpx.py b/plugins/modules/ibm_lb_vpx.py index d83d9575d..0c4248340 100644 --- a/plugins/modules/ibm_lb_vpx.py +++ b/plugins/modules/ibm_lb_vpx.py @@ -22,29 +22,14 @@ - Terraform v0.12.20 options: - datacenter: - description: - - (Required for new resource) Datacenter name - required: True - type: str - speed: - description: - - (Required for new resource) Speed value - required: True - type: int - public_subnet: - description: - - Public subnet - required: False - type: str private_subnet: description: - Private subnet required: False type: str - plan: + datacenter: description: - - (Required for new resource) Plan info + - (Required for new resource) Datacenter name required: True type: str ip_count: @@ -52,11 +37,6 @@ - (Required for new resource) IP address count required: True type: int - public_vlan_id: - description: - - Piblic VLAN id - required: False - type: int private_vlan_id: description: - Private VLAN id @@ -68,11 +48,31 @@ required: False type: list elements: str + public_vlan_id: + description: + - Piblic VLAN id + required: False + type: int + public_subnet: + description: + - Public subnet + required: False + type: str + speed: + description: + - (Required for new resource) Speed value + required: True + type: int version: description: - (Required for new resource) version info required: True type: str + plan: + description: + - (Required for new resource) Plan info + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -120,24 +120,24 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('datacenter', 'str'), - ('speed', 'int'), - ('plan', 'str'), ('ip_count', 'int'), + ('speed', 'int'), ('version', 'str'), + ('plan', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'datacenter', - 'speed', - 'public_subnet', 'private_subnet', - 'plan', + 'datacenter', 'ip_count', - 'public_vlan_id', 'private_vlan_id', 'tags', + 'public_vlan_id', + 'public_subnet', + 'speed', 'version', + 'plan', ] # Params for Data source @@ -154,27 +154,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - datacenter=dict( - required=False, - type='str'), - speed=dict( - required=False, - type='int'), - public_subnet=dict( - required=False, - type='str'), private_subnet=dict( required=False, type='str'), - plan=dict( + datacenter=dict( required=False, type='str'), ip_count=dict( required=False, type='int'), - public_vlan_id=dict( - required=False, - type='int'), private_vlan_id=dict( required=False, type='int'), @@ -182,9 +170,21 @@ required=False, elements='', type='list'), + public_vlan_id=dict( + required=False, + type='int'), + public_subnet=dict( + required=False, + type='str'), + speed=dict( + required=False, + type='int'), version=dict( required=False, type='str'), + plan=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_lb_vpx_service.py b/plugins/modules/ibm_lb_vpx_service.py index b0d8cdbc8..c9922a8ca 100644 --- a/plugins/modules/ibm_lb_vpx_service.py +++ b/plugins/modules/ibm_lb_vpx_service.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - name: - description: - - (Required for new resource) name - required: True - type: str destination_ip_address: description: - (Required for new resource) Destination IP Address @@ -42,27 +37,32 @@ - (Required for new resource) Weight value required: True type: int - connection_limit: - description: - - (Required for new resource) Number of connections limit - required: True - type: int health_check: description: - (Required for new resource) Health check info required: True type: str + vip_id: + description: + - (Required for new resource) VIP id + required: True + type: str + name: + description: + - (Required for new resource) name + required: True + type: str + connection_limit: + description: + - (Required for new resource) Number of connections limit + required: True + type: int usip: description: - usip info required: False type: str default: NO - vip_id: - description: - - (Required for new resource) VIP id - required: True - type: str tags: description: - list of tags associated with the resource @@ -115,25 +115,25 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('destination_ip_address', 'str'), ('destination_port', 'int'), ('weight', 'int'), - ('connection_limit', 'int'), ('health_check', 'str'), ('vip_id', 'str'), + ('name', 'str'), + ('connection_limit', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'destination_ip_address', 'destination_port', 'weight', - 'connection_limit', 'health_check', - 'usip', 'vip_id', + 'name', + 'connection_limit', + 'usip', 'tags', ] @@ -151,9 +151,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=False, - type='str'), destination_ip_address=dict( required=False, type='str'), @@ -163,16 +160,19 @@ weight=dict( required=False, type='int'), - connection_limit=dict( - required=False, - type='int'), health_check=dict( required=False, type='str'), - usip=dict( + vip_id=dict( required=False, type='str'), - vip_id=dict( + name=dict( + required=False, + type='str'), + connection_limit=dict( + required=False, + type='int'), + usip=dict( required=False, type='str'), tags=dict( diff --git a/plugins/modules/ibm_lb_vpx_vip.py b/plugins/modules/ibm_lb_vpx_vip.py index 5dcbab209..d7065b074 100644 --- a/plugins/modules/ibm_lb_vpx_vip.py +++ b/plugins/modules/ibm_lb_vpx_vip.py @@ -22,21 +22,31 @@ - Terraform v0.12.20 options: - nad_controller_id: + name: description: - - (Required for new resource) NAD controller ID + - (Required for new resource) Name required: True - type: int - source_port: + type: str + type: description: - - (Required for new resource) Source Port number + - (Required for new resource) Type required: True - type: int + type: str security_certificate_id: description: - security certificate ID required: False type: int + nad_controller_id: + description: + - (Required for new resource) NAD controller ID + required: True + type: int + persistence: + description: + - Persistance value + required: False + type: str virtual_ip_address: description: - (Required for new resource) Virtual IP address @@ -53,21 +63,11 @@ - (Required for new resource) Load balancing method required: True type: str - persistence: - description: - - Persistance value - required: False - type: str - name: - description: - - (Required for new resource) Name - required: True - type: str - type: + source_port: description: - - (Required for new resource) Type + - (Required for new resource) Source Port number required: True - type: str + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -114,25 +114,25 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('name', 'str'), + ('type', 'str'), ('nad_controller_id', 'int'), - ('source_port', 'int'), ('virtual_ip_address', 'str'), ('load_balancing_method', 'str'), - ('name', 'str'), - ('type', 'str'), + ('source_port', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'nad_controller_id', - 'source_port', + 'name', + 'type', 'security_certificate_id', + 'nad_controller_id', + 'persistence', 'virtual_ip_address', 'tags', 'load_balancing_method', - 'persistence', - 'name', - 'type', + 'source_port', ] # Params for Data source @@ -149,15 +149,21 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - nad_controller_id=dict( + name=dict( required=False, - type='int'), - source_port=dict( + type='str'), + type=dict( required=False, - type='int'), + type='str'), security_certificate_id=dict( required=False, type='int'), + nad_controller_id=dict( + required=False, + type='int'), + persistence=dict( + required=False, + type='str'), virtual_ip_address=dict( required=False, type='str'), @@ -168,15 +174,9 @@ load_balancing_method=dict( required=False, type='str'), - persistence=dict( - required=False, - type='str'), - name=dict( - required=False, - type='str'), - type=dict( + source_port=dict( required=False, - type='str'), + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_lbaas.py b/plugins/modules/ibm_lbaas.py index ab06bcda6..1070dc798 100644 --- a/plugins/modules/ibm_lbaas.py +++ b/plugins/modules/ibm_lbaas.py @@ -27,46 +27,46 @@ - Description of a load balancer. required: False type: str - ssl_ciphers: + subnets: description: - - None + - (Required for new resource) The subnet where this Load Balancer will be provisioned. + required: True + type: list + elements: int + protocols: + description: + - Protocols to be assigned to this load balancer. required: False type: list - elements: str + elements: dict name: description: - (Required for new resource) The load balancer's name. required: True type: str - wait_time_minutes: + type: description: - - None + - Specifies if a load balancer is public or private required: False - type: int - default: 90 - subnets: - description: - - (Required for new resource) The subnet where this Load Balancer will be provisioned. - required: True - type: list - elements: int + type: str + default: PUBLIC use_system_public_ip_pool: description: - "in public loadbalancer - Public IP address allocation done by system public IP pool or public subnet." required: False type: bool - protocols: + ssl_ciphers: description: - - Protocols to be assigned to this load balancer. + - None required: False type: list - elements: dict - type: + elements: str + wait_time_minutes: description: - - Specifies if a load balancer is public or private + - None required: False - type: str - default: PUBLIC + type: int + default: 90 id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -113,20 +113,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('subnets', 'list'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'description', - 'ssl_ciphers', - 'name', - 'wait_time_minutes', 'subnets', - 'use_system_public_ip_pool', 'protocols', + 'name', 'type', + 'use_system_public_ip_pool', + 'ssl_ciphers', + 'wait_time_minutes', ] # Params for Data source @@ -148,30 +148,30 @@ description=dict( required=False, type='str'), - ssl_ciphers=dict( + subnets=dict( + required=False, + elements='', + type='list'), + protocols=dict( required=False, elements='', type='list'), name=dict( required=False, type='str'), - wait_time_minutes=dict( - required=False, - type='int'), - subnets=dict( + type=dict( required=False, - elements='', - type='list'), + type='str'), use_system_public_ip_pool=dict( required=False, type='bool'), - protocols=dict( + ssl_ciphers=dict( required=False, elements='', type='list'), - type=dict( + wait_time_minutes=dict( required=False, - type='str'), + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_lbaas_health_monitor.py b/plugins/modules/ibm_lbaas_health_monitor.py index 59ddc4609..97a9f502c 100644 --- a/plugins/modules/ibm_lbaas_health_monitor.py +++ b/plugins/modules/ibm_lbaas_health_monitor.py @@ -22,27 +22,6 @@ - Terraform v0.12.20 options: - url_path: - description: - - URL Path - required: False - type: str - default: / - monitor_id: - description: - - (Required for new resource) Monitor ID - required: True - type: str - lbaas_id: - description: - - (Required for new resource) LBAAS id - required: True - type: str - protocol: - description: - - (Required for new resource) Protocol value - required: True - type: str port: description: - (Required for new resource) Port number @@ -66,6 +45,27 @@ required: False type: int default: 2 + url_path: + description: + - URL Path + required: False + type: str + default: / + monitor_id: + description: + - (Required for new resource) Monitor ID + required: True + type: str + lbaas_id: + description: + - (Required for new resource) LBAAS id + required: True + type: str + protocol: + description: + - (Required for new resource) Protocol value + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -112,22 +112,22 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('port', 'int'), ('monitor_id', 'str'), ('lbaas_id', 'str'), ('protocol', 'str'), - ('port', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'url_path', - 'monitor_id', - 'lbaas_id', - 'protocol', 'port', 'interval', 'max_retries', 'timeout', + 'url_path', + 'monitor_id', + 'lbaas_id', + 'protocol', ] # Params for Data source @@ -144,18 +144,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - url_path=dict( - required=False, - type='str'), - monitor_id=dict( - required=False, - type='str'), - lbaas_id=dict( - required=False, - type='str'), - protocol=dict( - required=False, - type='str'), port=dict( required=False, type='int'), @@ -168,6 +156,18 @@ timeout=dict( required=False, type='int'), + url_path=dict( + required=False, + type='str'), + monitor_id=dict( + required=False, + type='str'), + lbaas_id=dict( + required=False, + type='str'), + protocol=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_multi_vlan_firewall.py b/plugins/modules/ibm_multi_vlan_firewall.py index cd84aa448..2d443af7b 100644 --- a/plugins/modules/ibm_multi_vlan_firewall.py +++ b/plugins/modules/ibm_multi_vlan_firewall.py @@ -22,6 +22,17 @@ - Terraform v0.12.20 options: + addon_configuration: + description: + - High Availability - [Web Filtering Add-on, NGFW Add-on, AV Add-on] or [Web Filtering Add-on, NGFW Add-on, AV Add-on] + required: False + type: list + elements: str + pod: + description: + - (Required for new resource) POD name + required: True + type: str name: description: - (Required for new resource) name @@ -37,17 +48,6 @@ - (Required for new resource) Datacenter name required: True type: str - addon_configuration: - description: - - High Availability - [Web Filtering Add-on, NGFW Add-on, AV Add-on] or [Web Filtering Add-on, NGFW Add-on, AV Add-on] - required: False - type: list - elements: str - pod: - description: - - (Required for new resource) POD name - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -94,19 +94,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('pod', 'str'), ('name', 'str'), ('firewall_type', 'str'), ('datacenter', 'str'), - ('pod', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'addon_configuration', + 'pod', 'name', 'firewall_type', 'datacenter', - 'addon_configuration', - 'pod', ] # Params for Data source @@ -123,6 +123,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + addon_configuration=dict( + required=False, + elements='', + type='list'), + pod=dict( + required=False, + type='str'), name=dict( required=False, type='str'), @@ -132,13 +139,6 @@ datacenter=dict( required=False, type='str'), - addon_configuration=dict( - required=False, - elements='', - type='list'), - pod=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_network_gateway.py b/plugins/modules/ibm_network_gateway.py index 33791457d..56a26ddc1 100644 --- a/plugins/modules/ibm_network_gateway.py +++ b/plugins/modules/ibm_network_gateway.py @@ -22,28 +22,28 @@ - Terraform v0.12.20 options: + name: + description: + - (Required for new resource) The name of the gateway + required: True + type: str ssh_key_ids: description: - None required: False type: list elements: int + post_install_script_uri: + description: + - None + required: False + type: str members: description: - (Required for new resource) The hardware members of this network Gateway required: True type: list elements: dict - name: - description: - - (Required for new resource) The name of the gateway - required: True - type: str - post_install_script_uri: - description: - - None - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -90,16 +90,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('members', 'list'), ('name', 'str'), + ('members', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'ssh_key_ids', - 'members', 'name', + 'ssh_key_ids', 'post_install_script_uri', + 'members', ] # Params for Data source @@ -116,20 +116,20 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + name=dict( + required=False, + type='str'), ssh_key_ids=dict( required=False, elements='', type='list'), + post_install_script_uri=dict( + required=False, + type='str'), members=dict( required=False, elements='', type='list'), - name=dict( - required=False, - type='str'), - post_install_script_uri=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_network_gateway_vlan_association.py b/plugins/modules/ibm_network_gateway_vlan_association.py index 33a15dab1..7ab568e71 100644 --- a/plugins/modules/ibm_network_gateway_vlan_association.py +++ b/plugins/modules/ibm_network_gateway_vlan_association.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - gateway_id: - description: - - (Required for new resource) Gateway instance ID - required: True - type: int network_vlan_id: description: - (Required for new resource) The Identifier of the VLAN to be associated @@ -38,6 +33,11 @@ required: False type: bool default: True + gateway_id: + description: + - (Required for new resource) Gateway instance ID + required: True + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -84,15 +84,15 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('gateway_id', 'int'), ('network_vlan_id', 'int'), + ('gateway_id', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'gateway_id', 'network_vlan_id', 'bypass', + 'gateway_id', ] # Params for Data source @@ -109,15 +109,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - gateway_id=dict( - required=False, - type='int'), network_vlan_id=dict( required=False, type='int'), bypass=dict( required=False, type='bool'), + gateway_id=dict( + required=False, + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_network_vlan.py b/plugins/modules/ibm_network_vlan.py index 5a4b16b79..5a4de99da 100644 --- a/plugins/modules/ibm_network_vlan.py +++ b/plugins/modules/ibm_network_vlan.py @@ -33,11 +33,6 @@ - (Required for new resource) Datacenter name required: True type: str - name: - description: - - VLAN name - required: False - type: str router_hostname: description: - router host name @@ -48,6 +43,11 @@ - (Required for new resource) VLAN type required: True type: str + name: + description: + - VLAN name + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -102,9 +102,9 @@ TL_ALL_PARAMETERS = [ 'tags', 'datacenter', - 'name', 'router_hostname', 'type', + 'name', ] # Params for Data source @@ -112,9 +112,9 @@ ] TL_ALL_PARAMETERS_DS = [ - 'number', 'router_hostname', 'name', + 'number', ] TL_CONFLICTS_MAP = { @@ -131,15 +131,15 @@ datacenter=dict( required=False, type='str'), - name=dict( - required=False, - type='str'), router_hostname=dict( required=False, type='str'), type=dict( required=False, type='str'), + name=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_network_vlan_info.py b/plugins/modules/ibm_network_vlan_info.py index bc270d1b5..39ca8a8f2 100644 --- a/plugins/modules/ibm_network_vlan_info.py +++ b/plugins/modules/ibm_network_vlan_info.py @@ -21,11 +21,6 @@ - Terraform v0.12.20 options: - number: - description: - - None - required: False - type: int router_hostname: description: - None @@ -36,6 +31,11 @@ - None required: False type: str + number: + description: + - None + required: False + type: int iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -73,9 +73,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'number', 'router_hostname', 'name', + 'number', ] @@ -86,15 +86,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - number=dict( - required=False, - type='int'), router_hostname=dict( required=False, type='str'), name=dict( required=False, type='str'), + number=dict( + required=False, + type='int'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_ob_logging.py b/plugins/modules/ibm_ob_logging.py index f084206f3..68438d4e8 100644 --- a/plugins/modules/ibm_ob_logging.py +++ b/plugins/modules/ibm_ob_logging.py @@ -22,16 +22,6 @@ - Terraform v0.12.20 options: - logdna_ingestion_key: - description: - - LogDNA ingestion key - required: False - type: str - private_endpoint: - description: - - Add this option to connect to your LogDNA service instance through the private service endpoint - required: False - type: bool cluster: description: - (Required for new resource) Name or ID of the cluster to be used. @@ -42,6 +32,16 @@ - (Required for new resource) ID of the LogDNA service instance to latch required: True type: str + private_endpoint: + description: + - Add this option to connect to your LogDNA service instance through the private service endpoint + required: False + type: bool + logdna_ingestion_key: + description: + - LogDNA ingestion key + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -94,10 +94,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'logdna_ingestion_key', - 'private_endpoint', 'cluster', 'instance_id', + 'private_endpoint', + 'logdna_ingestion_key', ] # Params for Data source @@ -114,16 +114,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - logdna_ingestion_key=dict( + cluster=dict( + required=False, + type='str'), + instance_id=dict( required=False, type='str'), private_endpoint=dict( required=False, type='bool'), - cluster=dict( - required=False, - type='str'), - instance_id=dict( + logdna_ingestion_key=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_ob_monitoring.py b/plugins/modules/ibm_ob_monitoring.py index fcbc66cfb..b89095f79 100644 --- a/plugins/modules/ibm_ob_monitoring.py +++ b/plugins/modules/ibm_ob_monitoring.py @@ -22,16 +22,16 @@ - Terraform v0.12.20 options: - cluster: - description: - - (Required for new resource) Name or ID of the cluster to be used. - required: True - type: str private_endpoint: description: - Add this option to connect to your Sysdig service instance through the private service endpoint required: False type: bool + cluster: + description: + - (Required for new resource) Name or ID of the cluster to be used. + required: True + type: str instance_id: description: - (Required for new resource) ID of the Sysdig service instance to latch @@ -94,8 +94,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'cluster', 'private_endpoint', + 'cluster', 'instance_id', 'sysdig_access_key', ] @@ -114,12 +114,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - cluster=dict( - required=False, - type='str'), private_endpoint=dict( required=False, type='bool'), + cluster=dict( + required=False, + type='str'), instance_id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_org.py b/plugins/modules/ibm_org.py index d08be0f6e..6a3089956 100644 --- a/plugins/modules/ibm_org.py +++ b/plugins/modules/ibm_org.py @@ -22,6 +22,22 @@ - Terraform v0.12.20 options: + name: + description: + - (Required for new resource) Org name, for example myorg@domain + required: True + type: str + org_quota_definition_guid: + description: + - Org quota guid + required: False + type: str + billing_managers: + description: + - The IBMID of the users who will have billing manager role in this org, ex - user@example.com + required: False + type: list + elements: str managers: description: - The IBMID of the users who will have manager role in this org, ex - user@example.com @@ -46,22 +62,6 @@ required: False type: list elements: str - name: - description: - - (Required for new resource) Org name, for example myorg@domain - required: True - type: str - org_quota_definition_guid: - description: - - Org quota guid - required: False - type: str - billing_managers: - description: - - The IBMID of the users who will have billing manager role in this org, ex - user@example.com - required: False - type: list - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -113,13 +113,13 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'name', + 'org_quota_definition_guid', + 'billing_managers', 'managers', 'auditors', 'users', 'tags', - 'name', - 'org_quota_definition_guid', - 'billing_managers', ] # Params for Data source @@ -138,6 +138,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + name=dict( + required=False, + type='str'), + org_quota_definition_guid=dict( + required=False, + type='str'), + billing_managers=dict( + required=False, + elements='', + type='list'), managers=dict( required=False, elements='', @@ -154,16 +164,6 @@ required=False, elements='', type='list'), - name=dict( - required=False, - type='str'), - org_quota_definition_guid=dict( - required=False, - type='str'), - billing_managers=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_pi_capture.py b/plugins/modules/ibm_pi_capture.py index ada21659c..2c54f8a3b 100644 --- a/plugins/modules/ibm_pi_capture.py +++ b/plugins/modules/ibm_pi_capture.py @@ -22,9 +22,19 @@ - Terraform v0.12.20 options: - pi_capture_name: + pi_capture_cloud_storage_access_key: description: - - (Required for new resource) Name of the capture to create. Note : this must be unique + - Name of Cloud Storage Access Key + required: False + type: str + pi_capture_storage_image_path: + description: + - Cloud Storage Image Path (bucket-name [/folder/../..]) + required: False + type: str + pi_cloud_instance_id: + description: + - (Required for new resource) Cloud Instance ID - This is the service_instance_id. required: True type: str pi_capture_destination: @@ -32,42 +42,32 @@ - (Required for new resource) Destination for the deployable image required: True type: str - pi_capture_volume_ids: + pi_capture_cloud_storage_region: description: - - List of Data volume IDs + - List of Regions to use required: False - type: list - elements: str + type: str pi_capture_cloud_storage_secret_key: description: - Name of the Cloud Storage Secret Key required: False type: str - pi_cloud_instance_id: - description: - - (Required for new resource) Cloud Instance ID - This is the service_instance_id. - required: True - type: str pi_instance_name: description: - (Required for new resource) Instance Name of the Power VM required: True type: str - pi_capture_storage_image_path: - description: - - Cloud Storage Image Path (bucket-name [/folder/../..]) - required: False - type: str - pi_capture_cloud_storage_region: + pi_capture_name: description: - - List of Regions to use - required: False + - (Required for new resource) Name of the capture to create. Note : this must be unique + required: True type: str - pi_capture_cloud_storage_access_key: + pi_capture_volume_ids: description: - - Name of Cloud Storage Access Key + - List of Data volume IDs required: False - type: str + type: list + elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -110,23 +110,23 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_capture_name', 'str'), - ('pi_capture_destination', 'str'), ('pi_cloud_instance_id', 'str'), + ('pi_capture_destination', 'str'), ('pi_instance_name', 'str'), + ('pi_capture_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_capture_name', + 'pi_capture_cloud_storage_access_key', + 'pi_capture_storage_image_path', + 'pi_cloud_instance_id', 'pi_capture_destination', - 'pi_capture_volume_ids', + 'pi_capture_cloud_storage_region', 'pi_capture_cloud_storage_secret_key', - 'pi_cloud_instance_id', 'pi_instance_name', - 'pi_capture_storage_image_path', - 'pi_capture_cloud_storage_region', - 'pi_capture_cloud_storage_access_key', + 'pi_capture_name', + 'pi_capture_volume_ids', ] # Params for Data source @@ -143,34 +143,34 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_capture_name=dict( + pi_capture_cloud_storage_access_key=dict( required=False, type='str'), - pi_capture_destination=dict( + pi_capture_storage_image_path=dict( required=False, type='str'), - pi_capture_volume_ids=dict( - required=False, - elements='', - type='list'), - pi_capture_cloud_storage_secret_key=dict( + pi_cloud_instance_id=dict( required=False, type='str'), - pi_cloud_instance_id=dict( + pi_capture_destination=dict( required=False, type='str'), - pi_instance_name=dict( + pi_capture_cloud_storage_region=dict( required=False, type='str'), - pi_capture_storage_image_path=dict( + pi_capture_cloud_storage_secret_key=dict( required=False, type='str'), - pi_capture_cloud_storage_region=dict( + pi_instance_name=dict( required=False, type='str'), - pi_capture_cloud_storage_access_key=dict( + pi_capture_name=dict( required=False, type='str'), + pi_capture_volume_ids=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_pi_cloud_connection.py b/plugins/modules/ibm_pi_cloud_connection.py index 151d5bc56..f516a45fd 100644 --- a/plugins/modules/ibm_pi_cloud_connection.py +++ b/plugins/modules/ibm_pi_cloud_connection.py @@ -32,55 +32,55 @@ - (Required for new resource) Speed of the cloud connection (speed in megabits per second) required: True type: int - pi_cloud_connection_gre_cidr: - description: - - GRE network in CIDR notation - required: False - type: str - pi_cloud_connection_vpc_crns: + pi_cloud_connection_global_routing: description: - - Set of VPCs to attach to this cloud connection + - Enable global routing for this cloud connection required: False - type: list - elements: str + type: bool + default: False pi_cloud_connection_metered: description: - Enable metered for this cloud connection required: False type: bool default: False - pi_cloud_connection_networks: + pi_cloud_connection_gre_destination_address: description: - - Set of Networks to attach to this cloud connection + - GRE destination IP address required: False - type: list - elements: str + type: str pi_cloud_connection_vpc_enabled: description: - Enable VPC for this cloud connection required: False type: bool default: False - pi_cloud_connection_name: + pi_cloud_connection_vpc_crns: description: - - (Required for new resource) Name of the cloud connection - required: True - type: str - pi_cloud_connection_global_routing: + - Set of VPCs to attach to this cloud connection + required: False + type: list + elements: str + pi_cloud_connection_networks: description: - - Enable global routing for this cloud connection + - Set of Networks to attach to this cloud connection required: False - type: bool - default: False + type: list + elements: str pi_cloud_connection_classic_enabled: description: - Enable classic endpoint destination required: False type: bool default: False - pi_cloud_connection_gre_destination_address: + pi_cloud_connection_name: description: - - GRE destination IP address + - (Required for new resource) Name of the cloud connection + required: True + type: str + pi_cloud_connection_gre_cidr: + description: + - GRE network in CIDR notation required: False type: str id: @@ -134,15 +134,15 @@ TL_ALL_PARAMETERS = [ 'pi_cloud_instance_id', 'pi_cloud_connection_speed', - 'pi_cloud_connection_gre_cidr', - 'pi_cloud_connection_vpc_crns', + 'pi_cloud_connection_global_routing', 'pi_cloud_connection_metered', - 'pi_cloud_connection_networks', + 'pi_cloud_connection_gre_destination_address', 'pi_cloud_connection_vpc_enabled', - 'pi_cloud_connection_name', - 'pi_cloud_connection_global_routing', + 'pi_cloud_connection_vpc_crns', + 'pi_cloud_connection_networks', 'pi_cloud_connection_classic_enabled', - 'pi_cloud_connection_gre_destination_address', + 'pi_cloud_connection_name', + 'pi_cloud_connection_gre_cidr', ] # Params for Data source @@ -169,33 +169,33 @@ pi_cloud_connection_speed=dict( required=False, type='int'), - pi_cloud_connection_gre_cidr=dict( + pi_cloud_connection_global_routing=dict( + required=False, + type='bool'), + pi_cloud_connection_metered=dict( + required=False, + type='bool'), + pi_cloud_connection_gre_destination_address=dict( required=False, type='str'), + pi_cloud_connection_vpc_enabled=dict( + required=False, + type='bool'), pi_cloud_connection_vpc_crns=dict( required=False, elements='', type='list'), - pi_cloud_connection_metered=dict( - required=False, - type='bool'), pi_cloud_connection_networks=dict( required=False, elements='', type='list'), - pi_cloud_connection_vpc_enabled=dict( + pi_cloud_connection_classic_enabled=dict( required=False, type='bool'), pi_cloud_connection_name=dict( required=False, type='str'), - pi_cloud_connection_global_routing=dict( - required=False, - type='bool'), - pi_cloud_connection_classic_enabled=dict( - required=False, - type='bool'), - pi_cloud_connection_gre_destination_address=dict( + pi_cloud_connection_gre_cidr=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_console_language.py b/plugins/modules/ibm_pi_console_language.py index 0ef4da697..90d5bf018 100644 --- a/plugins/modules/ibm_pi_console_language.py +++ b/plugins/modules/ibm_pi_console_language.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + pi_language_code: + description: + - (Required for new resource) Language code + required: True + type: str pi_cloud_instance_id: description: - (Required for new resource) PI cloud instance ID @@ -32,11 +37,6 @@ - (Required for new resource) The unique identifier or name of the instance required: True type: str - pi_language_code: - description: - - (Required for new resource) Language code - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -79,16 +79,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('pi_language_code', 'str'), ('pi_cloud_instance_id', 'str'), ('pi_instance_name', 'str'), - ('pi_language_code', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'pi_language_code', 'pi_cloud_instance_id', 'pi_instance_name', - 'pi_language_code', ] # Params for Data source @@ -105,13 +105,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_cloud_instance_id=dict( + pi_language_code=dict( required=False, type='str'), - pi_instance_name=dict( + pi_cloud_instance_id=dict( required=False, type='str'), - pi_language_code=dict( + pi_instance_name=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_dhcp.py b/plugins/modules/ibm_pi_dhcp.py index 06378b394..ad02c1af0 100644 --- a/plugins/modules/ibm_pi_dhcp.py +++ b/plugins/modules/ibm_pi_dhcp.py @@ -79,13 +79,13 @@ # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('pi_dhcp_id', 'str'), ('pi_cloud_instance_id', 'str'), + ('pi_dhcp_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'pi_dhcp_id', 'pi_cloud_instance_id', + 'pi_dhcp_id', ] TL_CONFLICTS_MAP = { diff --git a/plugins/modules/ibm_pi_dhcp_info.py b/plugins/modules/ibm_pi_dhcp_info.py index 9fbab6c42..767701664 100644 --- a/plugins/modules/ibm_pi_dhcp_info.py +++ b/plugins/modules/ibm_pi_dhcp_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - pi_dhcp_id: + pi_cloud_instance_id: description: - - The ID of the DHCP Server + - None required: True type: str - pi_cloud_instance_id: + pi_dhcp_id: description: - - None + - The ID of the DHCP Server required: True type: str zone: @@ -60,14 +60,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_dhcp_id', 'str'), ('pi_cloud_instance_id', 'str'), + ('pi_dhcp_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_dhcp_id', 'pi_cloud_instance_id', + 'pi_dhcp_id', ] @@ -78,10 +78,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_dhcp_id=dict( + pi_cloud_instance_id=dict( required=True, type='str'), - pi_cloud_instance_id=dict( + pi_dhcp_id=dict( required=True, type='str'), zone=dict( diff --git a/plugins/modules/ibm_pi_ike_policy.py b/plugins/modules/ibm_pi_ike_policy.py index ee8824aa2..aff20289f 100644 --- a/plugins/modules/ibm_pi_ike_policy.py +++ b/plugins/modules/ibm_pi_ike_policy.py @@ -22,29 +22,14 @@ - Terraform v0.12.20 options: - pi_cloud_instance_id: - description: - - (Required for new resource) PI cloud instance ID - required: True - type: str - pi_policy_encryption: - description: - - (Required for new resource) Encryption of the IKE Policy - required: True - type: str pi_policy_key_lifetime: description: - (Required for new resource) Policy key lifetime required: True type: int - pi_policy_version: - description: - - (Required for new resource) Version of the IKE Policy - required: True - type: int - pi_policy_name: + pi_policy_preshared_key: description: - - (Required for new resource) Name of the IKE Policy + - (Required for new resource) Preshared key used in this IKE Policy (length of preshared key must be even) required: True type: str pi_policy_dh_group: @@ -52,17 +37,32 @@ - (Required for new resource) DH group of the IKE Policy required: True type: int - pi_policy_preshared_key: + pi_policy_encryption: description: - - (Required for new resource) Preshared key used in this IKE Policy (length of preshared key must be even) + - (Required for new resource) Encryption of the IKE Policy required: True type: str + pi_policy_version: + description: + - (Required for new resource) Version of the IKE Policy + required: True + type: int pi_policy_authentication: description: - Authentication for the IKE Policy required: False type: str default: none + pi_cloud_instance_id: + description: + - (Required for new resource) PI cloud instance ID + required: True + type: str + pi_policy_name: + description: + - (Required for new resource) Name of the IKE Policy + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -105,25 +105,25 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_cloud_instance_id', 'str'), - ('pi_policy_encryption', 'str'), ('pi_policy_key_lifetime', 'int'), + ('pi_policy_preshared_key', 'str'), + ('pi_policy_dh_group', 'int'), + ('pi_policy_encryption', 'str'), ('pi_policy_version', 'int'), + ('pi_cloud_instance_id', 'str'), ('pi_policy_name', 'str'), - ('pi_policy_dh_group', 'int'), - ('pi_policy_preshared_key', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_cloud_instance_id', - 'pi_policy_encryption', 'pi_policy_key_lifetime', - 'pi_policy_version', - 'pi_policy_name', - 'pi_policy_dh_group', 'pi_policy_preshared_key', + 'pi_policy_dh_group', + 'pi_policy_encryption', + 'pi_policy_version', 'pi_policy_authentication', + 'pi_cloud_instance_id', + 'pi_policy_name', ] # Params for Data source @@ -140,28 +140,28 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_cloud_instance_id=dict( + pi_policy_key_lifetime=dict( required=False, - type='str'), - pi_policy_encryption=dict( + type='int'), + pi_policy_preshared_key=dict( required=False, type='str'), - pi_policy_key_lifetime=dict( + pi_policy_dh_group=dict( required=False, type='int'), + pi_policy_encryption=dict( + required=False, + type='str'), pi_policy_version=dict( required=False, type='int'), - pi_policy_name=dict( + pi_policy_authentication=dict( required=False, type='str'), - pi_policy_dh_group=dict( - required=False, - type='int'), - pi_policy_preshared_key=dict( + pi_cloud_instance_id=dict( required=False, type='str'), - pi_policy_authentication=dict( + pi_policy_name=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_image.py b/plugins/modules/ibm_pi_image.py index d54eece4e..d10ab1918 100644 --- a/plugins/modules/ibm_pi_image.py +++ b/plugins/modules/ibm_pi_image.py @@ -22,25 +22,14 @@ - Terraform v0.12.20 options: - pi_image_name: - description: - - (Required for new resource) Image name - required: True - type: str - pi_image_id: - description: - - Instance image id - required: False - type: str - pi_image_bucket_access: + pi_image_access_key: description: - - Indicates if the bucket has public or private access + - Cloud Object Storage access key; required for buckets with private access required: False type: str - default: public - pi_image_access_key: + pi_image_secret_key: description: - - Cloud Object Storage access key; required for buckets with private access + - Cloud Object Storage secret key; required for buckets with private access required: False type: str pi_image_bucket_region: @@ -48,31 +37,42 @@ - Cloud Object Storage region required: False type: str - pi_image_bucket_file_name: + pi_image_storage_type: description: - - Cloud Object Storage image filename + - Type of storage required: False type: str - pi_image_storage_type: + pi_image_bucket_name: description: - - Type of storage + - Cloud Object Storage bucket name; bucket-name[/optional/folder] required: False type: str - pi_cloud_instance_id: + pi_image_name: description: - - (Required for new resource) PI cloud instance ID + - (Required for new resource) Image name required: True type: str - pi_image_bucket_name: + pi_image_id: description: - - Cloud Object Storage bucket name; bucket-name[/optional/folder] + - Instance image id required: False type: str - pi_image_secret_key: + pi_image_bucket_access: description: - - Cloud Object Storage secret key; required for buckets with private access + - Indicates if the bucket has public or private access + required: False + type: str + default: public + pi_image_bucket_file_name: + description: + - Cloud Object Storage image filename required: False type: str + pi_cloud_instance_id: + description: + - (Required for new resource) PI cloud instance ID + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -121,69 +121,69 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'pi_image_access_key', + 'pi_image_secret_key', + 'pi_image_bucket_region', + 'pi_image_storage_type', + 'pi_image_bucket_name', 'pi_image_name', 'pi_image_id', 'pi_image_bucket_access', - 'pi_image_access_key', - 'pi_image_bucket_region', 'pi_image_bucket_file_name', - 'pi_image_storage_type', 'pi_cloud_instance_id', - 'pi_image_bucket_name', - 'pi_image_secret_key', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('pi_cloud_instance_id', 'str'), ('pi_image_name', 'str'), + ('pi_cloud_instance_id', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'pi_cloud_instance_id', 'pi_image_name', + 'pi_cloud_instance_id', ] TL_CONFLICTS_MAP = { + 'pi_image_bucket_region': ['pi_image_id'], + 'pi_image_bucket_name': ['pi_image_id'], 'pi_image_id': ['pi_image_bucket_name'], 'pi_image_bucket_access': ['pi_image_id'], - 'pi_image_bucket_region': ['pi_image_id'], 'pi_image_bucket_file_name': ['pi_image_id'], - 'pi_image_bucket_name': ['pi_image_id'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_image_name=dict( + pi_image_access_key=dict( required=False, type='str'), - pi_image_id=dict( + pi_image_secret_key=dict( required=False, type='str'), - pi_image_bucket_access=dict( + pi_image_bucket_region=dict( required=False, type='str'), - pi_image_access_key=dict( + pi_image_storage_type=dict( required=False, type='str'), - pi_image_bucket_region=dict( + pi_image_bucket_name=dict( required=False, type='str'), - pi_image_bucket_file_name=dict( + pi_image_name=dict( required=False, type='str'), - pi_image_storage_type=dict( + pi_image_id=dict( required=False, type='str'), - pi_cloud_instance_id=dict( + pi_image_bucket_access=dict( required=False, type='str'), - pi_image_bucket_name=dict( + pi_image_bucket_file_name=dict( required=False, type='str'), - pi_image_secret_key=dict( + pi_cloud_instance_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_image_info.py b/plugins/modules/ibm_pi_image_info.py index 362abb25e..f0db74ecd 100644 --- a/plugins/modules/ibm_pi_image_info.py +++ b/plugins/modules/ibm_pi_image_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - pi_cloud_instance_id: + pi_image_name: description: - - None + - Imagename Name to be used for pvminstances required: True type: str - pi_image_name: + pi_cloud_instance_id: description: - - Imagename Name to be used for pvminstances + - None required: True type: str zone: @@ -60,14 +60,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_cloud_instance_id', 'str'), ('pi_image_name', 'str'), + ('pi_cloud_instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_cloud_instance_id', 'pi_image_name', + 'pi_cloud_instance_id', ] @@ -78,10 +78,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_cloud_instance_id=dict( + pi_image_name=dict( required=True, type='str'), - pi_image_name=dict( + pi_cloud_instance_id=dict( required=True, type='str'), zone=dict( diff --git a/plugins/modules/ibm_pi_instance.py b/plugins/modules/ibm_pi_instance.py index 12c304bd3..f6f156416 100644 --- a/plugins/modules/ibm_pi_instance.py +++ b/plugins/modules/ibm_pi_instance.py @@ -22,21 +22,9 @@ - Terraform v0.12.20 options: - pi_replication_scheme: - description: - - Replication scheme - required: False - type: str - default: suffix - pi_health_status: - description: - - Allow the user to set the status of the lpar so that they can connect to it faster - required: False - type: str - default: OK - pi_affinity_volume: + pi_storage_pool: description: - - Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided + - Storage Pool for server deployment; if provided then pi_affinity_policy and pi_storage_type will be ignored required: False type: str pi_anti_affinity_volumes: @@ -45,143 +33,155 @@ required: False type: list elements: str - pi_storage_pool_affinity: + pi_proc_type: description: - - Indicates if all volumes attached to the server must reside in the same storage pool + - Instance processor type required: False - type: bool - default: True + type: str pi_sap_profile_id: description: - SAP Profile ID for the amount of cores and memory required: False type: str - pi_processors: - description: - - Processors count - required: False - type: float - pi_proc_type: + pi_pin_policy: description: - - Instance processor type + - Pin Policy of the instance required: False type: str - pi_volume_ids: + default: none + pi_image_id: description: - - List of PI volumes - required: False - type: list - elements: str - pi_affinity_instance: + - (Required for new resource) PI instance image id + required: True + type: str + pi_sys_type: description: - - PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and pi_affinity_volume is not provided + - PI Instance system type required: False type: str - pi_network: - description: - - (Required for new resource) List of one or more networks to attach to the instance - required: True - type: list - elements: dict - pi_migratable: + pi_replication_policy: description: - - set to true to enable migration of the PI instance + - Replication policy for the PI Instance required: False - type: bool - pi_storage_pool: + type: str + default: none + pi_affinity_policy: description: - - Storage Pool for server deployment; if provided then pi_affinity_policy and pi_storage_type will be ignored + - Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified required: False type: str - pi_instance_name: + pi_affinity_volume: description: - - (Required for new resource) PI Instance name - required: True + - Volume (ID or Name) to base storage affinity policy against; required if requesting affinity and pi_affinity_instance is not provided + required: False type: str - pi_replicants: + pi_memory: description: - - PI Instance replicas count + - Memory size required: False - type: int - default: 1 + type: float pi_cloud_instance_id: description: - (Required for new resource) This is the Power Instance id that is assigned to the account required: True type: str - pi_storage_type: + pi_volume_ids: description: - - Storage type for server deployment + - List of PI volumes required: False - type: str - pi_affinity_policy: + type: list + elements: str + pi_key_pair_name: description: - - Affinity policy for pvm instance being created; ignored if pi_storage_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified + - SSH key name required: False type: str - pi_image_id: + pi_replicants: description: - - (Required for new resource) PI instance image id - required: True - type: str - pi_storage_connection: + - PI Instance replicas count + required: False + type: int + default: 1 + pi_storage_pool_affinity: description: - - Storage Connectivity Group for server deployment + - Indicates if all volumes attached to the server must reside in the same storage pool required: False - type: str - pi_placement_group_id: + type: bool + default: True + pi_virtual_cores_assigned: description: - - Placement group ID + - Virtual Cores Assigned to the PVMInstance + required: False + type: int + pi_replication_scheme: + description: + - Replication scheme required: False type: str + default: suffix + pi_migratable: + description: + - set to true to enable migration of the PI instance + required: False + type: bool pi_user_data: description: - Base64 encoded data to be passed in for invoking a cloud init script required: False type: str - pi_replication_policy: + pi_anti_affinity_instances: description: - - Replication policy for the PI Instance + - List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided required: False - type: str - default: none - pi_pin_policy: + type: list + elements: str + pi_placement_group_id: description: - - Pin Policy of the instance + - Placement group ID required: False type: str - default: none - pi_key_pair_name: + pi_affinity_instance: description: - - SSH key name + - PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and pi_affinity_volume is not provided required: False type: str - pi_memory: + pi_storage_connection: description: - - Memory size + - Storage Connectivity Group for server deployment required: False - type: float - pi_virtual_cores_assigned: + type: str + pi_network: description: - - Virtual Cores Assigned to the PVMInstance - required: False - type: int + - (Required for new resource) List of one or more networks to attach to the instance + required: True + type: list + elements: dict + pi_instance_name: + description: + - (Required for new resource) PI Instance name + required: True + type: str pi_license_repository_capacity: description: - The VTL license repository capacity TB value required: False type: int - pi_anti_affinity_instances: + pi_storage_type: description: - - List of pvmInstances to base storage anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided + - Storage type for server deployment required: False - type: list - elements: str - pi_sys_type: + type: str + pi_processors: description: - - PI Instance system type + - Processors count + required: False + type: float + pi_health_status: + description: + - Allow the user to set the status of the lpar so that they can connect to it faster required: False type: str + default: OK id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -224,44 +224,44 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('pi_image_id', 'str'), + ('pi_cloud_instance_id', 'str'), ('pi_network', 'list'), ('pi_instance_name', 'str'), - ('pi_cloud_instance_id', 'str'), - ('pi_image_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_replication_scheme', - 'pi_health_status', - 'pi_affinity_volume', + 'pi_storage_pool', 'pi_anti_affinity_volumes', - 'pi_storage_pool_affinity', - 'pi_sap_profile_id', - 'pi_processors', 'pi_proc_type', - 'pi_volume_ids', - 'pi_affinity_instance', - 'pi_network', - 'pi_migratable', - 'pi_storage_pool', - 'pi_instance_name', - 'pi_replicants', - 'pi_cloud_instance_id', - 'pi_storage_type', - 'pi_affinity_policy', + 'pi_sap_profile_id', + 'pi_pin_policy', 'pi_image_id', - 'pi_storage_connection', - 'pi_placement_group_id', - 'pi_user_data', + 'pi_sys_type', 'pi_replication_policy', - 'pi_pin_policy', - 'pi_key_pair_name', + 'pi_affinity_policy', + 'pi_affinity_volume', 'pi_memory', + 'pi_cloud_instance_id', + 'pi_volume_ids', + 'pi_key_pair_name', + 'pi_replicants', + 'pi_storage_pool_affinity', 'pi_virtual_cores_assigned', - 'pi_license_repository_capacity', + 'pi_replication_scheme', + 'pi_migratable', + 'pi_user_data', 'pi_anti_affinity_instances', - 'pi_sys_type', + 'pi_placement_group_id', + 'pi_affinity_instance', + 'pi_storage_connection', + 'pi_network', + 'pi_instance_name', + 'pi_license_repository_capacity', + 'pi_storage_type', + 'pi_processors', + 'pi_health_status', ] # Params for Data source @@ -276,113 +276,113 @@ ] TL_CONFLICTS_MAP = { - 'pi_affinity_volume': ['pi_affinity_instance'], 'pi_anti_affinity_volumes': ['pi_anti_affinity_instances'], - 'pi_sap_profile_id': ['pi_processors', 'pi_memory', 'pi_proc_type', 'pi_sys_type'], - 'pi_processors': ['pi_sap_profile_id'], 'pi_proc_type': ['pi_sap_profile_id'], - 'pi_affinity_instance': ['pi_affinity_volume'], + 'pi_sap_profile_id': ['pi_processors', 'pi_memory', 'pi_proc_type', 'pi_sys_type'], + 'pi_sys_type': ['pi_sap_profile_id'], + 'pi_affinity_volume': ['pi_affinity_instance'], 'pi_memory': ['pi_sap_profile_id'], 'pi_anti_affinity_instances': ['pi_anti_affinity_volumes'], - 'pi_sys_type': ['pi_sap_profile_id'], + 'pi_affinity_instance': ['pi_affinity_volume'], + 'pi_processors': ['pi_sap_profile_id'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_replication_scheme=dict( - required=False, - type='str'), - pi_health_status=dict( - required=False, - type='str'), - pi_affinity_volume=dict( + pi_storage_pool=dict( required=False, type='str'), pi_anti_affinity_volumes=dict( required=False, elements='', type='list'), - pi_storage_pool_affinity=dict( + pi_proc_type=dict( required=False, - type='bool'), + type='str'), pi_sap_profile_id=dict( required=False, type='str'), - pi_processors=dict( - required=False, - type='float'), - pi_proc_type=dict( + pi_pin_policy=dict( required=False, type='str'), - pi_volume_ids=dict( - required=False, - elements='', - type='list'), - pi_affinity_instance=dict( + pi_image_id=dict( required=False, type='str'), - pi_network=dict( + pi_sys_type=dict( required=False, - elements='', - type='list'), - pi_migratable=dict( + type='str'), + pi_replication_policy=dict( required=False, - type='bool'), - pi_storage_pool=dict( + type='str'), + pi_affinity_policy=dict( required=False, type='str'), - pi_instance_name=dict( + pi_affinity_volume=dict( required=False, type='str'), - pi_replicants=dict( + pi_memory=dict( required=False, - type='int'), + type='float'), pi_cloud_instance_id=dict( required=False, type='str'), - pi_storage_type=dict( + pi_volume_ids=dict( required=False, - type='str'), - pi_affinity_policy=dict( + elements='', + type='list'), + pi_key_pair_name=dict( required=False, type='str'), - pi_image_id=dict( + pi_replicants=dict( required=False, - type='str'), - pi_storage_connection=dict( + type='int'), + pi_storage_pool_affinity=dict( required=False, - type='str'), - pi_placement_group_id=dict( + type='bool'), + pi_virtual_cores_assigned=dict( + required=False, + type='int'), + pi_replication_scheme=dict( required=False, type='str'), + pi_migratable=dict( + required=False, + type='bool'), pi_user_data=dict( required=False, type='str'), - pi_replication_policy=dict( + pi_anti_affinity_instances=dict( + required=False, + elements='', + type='list'), + pi_placement_group_id=dict( required=False, type='str'), - pi_pin_policy=dict( + pi_affinity_instance=dict( required=False, type='str'), - pi_key_pair_name=dict( + pi_storage_connection=dict( required=False, type='str'), - pi_memory=dict( + pi_network=dict( required=False, - type='float'), - pi_virtual_cores_assigned=dict( + elements='', + type='list'), + pi_instance_name=dict( required=False, - type='int'), + type='str'), pi_license_repository_capacity=dict( required=False, type='int'), - pi_anti_affinity_instances=dict( + pi_storage_type=dict( required=False, - elements='', - type='list'), - pi_sys_type=dict( + type='str'), + pi_processors=dict( + required=False, + type='float'), + pi_health_status=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_instance_ip_info.py b/plugins/modules/ibm_pi_instance_ip_info.py index 6ea981175..01097fc3e 100644 --- a/plugins/modules/ibm_pi_instance_ip_info.py +++ b/plugins/modules/ibm_pi_instance_ip_info.py @@ -21,19 +21,19 @@ - Terraform v0.12.20 options: - pi_cloud_instance_id: + pi_instance_name: description: - - None + - Server Name to be used for pvminstances required: True type: str - pi_network_name: + pi_cloud_instance_id: description: - None required: True type: str - pi_instance_name: + pi_network_name: description: - - Server Name to be used for pvminstances + - None required: True type: str zone: @@ -65,16 +65,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('pi_instance_name', 'str'), ('pi_cloud_instance_id', 'str'), ('pi_network_name', 'str'), - ('pi_instance_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'pi_instance_name', 'pi_cloud_instance_id', 'pi_network_name', - 'pi_instance_name', ] @@ -85,13 +85,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_cloud_instance_id=dict( + pi_instance_name=dict( required=True, type='str'), - pi_network_name=dict( + pi_cloud_instance_id=dict( required=True, type='str'), - pi_instance_name=dict( + pi_network_name=dict( required=True, type='str'), zone=dict( diff --git a/plugins/modules/ibm_pi_ipsec_policy.py b/plugins/modules/ibm_pi_ipsec_policy.py index c69df9847..6f03dabcf 100644 --- a/plugins/modules/ibm_pi_ipsec_policy.py +++ b/plugins/modules/ibm_pi_ipsec_policy.py @@ -22,16 +22,6 @@ - Terraform v0.12.20 options: - pi_policy_encryption: - description: - - (Required for new resource) Encryption of the IPSec Policy - required: True - type: str - pi_policy_key_lifetime: - description: - - (Required for new resource) Policy key lifetime - required: True - type: int pi_policy_pfs: description: - (Required for new resource) Perfect Forward Secrecy @@ -58,6 +48,16 @@ - (Required for new resource) DH group of the IPSec Policy required: True type: int + pi_policy_encryption: + description: + - (Required for new resource) Encryption of the IPSec Policy + required: True + type: str + pi_policy_key_lifetime: + description: + - (Required for new resource) Policy key lifetime + required: True + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -100,23 +100,23 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_policy_encryption', 'str'), - ('pi_policy_key_lifetime', 'int'), ('pi_policy_pfs', 'bool'), ('pi_cloud_instance_id', 'str'), ('pi_policy_name', 'str'), ('pi_policy_dh_group', 'int'), + ('pi_policy_encryption', 'str'), + ('pi_policy_key_lifetime', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_policy_encryption', - 'pi_policy_key_lifetime', 'pi_policy_pfs', 'pi_policy_authentication', 'pi_cloud_instance_id', 'pi_policy_name', 'pi_policy_dh_group', + 'pi_policy_encryption', + 'pi_policy_key_lifetime', ] # Params for Data source @@ -133,12 +133,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_policy_encryption=dict( - required=False, - type='str'), - pi_policy_key_lifetime=dict( - required=False, - type='int'), pi_policy_pfs=dict( required=False, type='bool'), @@ -154,6 +148,12 @@ pi_policy_dh_group=dict( required=False, type='int'), + pi_policy_encryption=dict( + required=False, + type='str'), + pi_policy_key_lifetime=dict( + required=False, + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_pi_key.py b/plugins/modules/ibm_pi_key.py index 4eb29ba4c..c65c73632 100644 --- a/plugins/modules/ibm_pi_key.py +++ b/plugins/modules/ibm_pi_key.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + pi_cloud_instance_id: + description: + - (Required for new resource) PI cloud instance ID + required: True + type: str pi_key_name: description: - (Required for new resource) Key name in the PI instance @@ -32,11 +37,6 @@ - (Required for new resource) PI instance key info required: True type: str - pi_cloud_instance_id: - description: - - (Required for new resource) PI cloud instance ID - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -79,16 +79,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('pi_cloud_instance_id', 'str'), ('pi_key_name', 'str'), ('pi_ssh_key', 'str'), - ('pi_cloud_instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'pi_cloud_instance_id', 'pi_key_name', 'pi_ssh_key', - 'pi_cloud_instance_id', ] # Params for Data source @@ -109,13 +109,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_key_name=dict( + pi_cloud_instance_id=dict( required=False, type='str'), - pi_ssh_key=dict( + pi_key_name=dict( required=False, type='str'), - pi_cloud_instance_id=dict( + pi_ssh_key=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_network.py b/plugins/modules/ibm_pi_network.py index 3bf3d283d..13434d7aa 100644 --- a/plugins/modules/ibm_pi_network.py +++ b/plugins/modules/ibm_pi_network.py @@ -22,11 +22,17 @@ - Terraform v0.12.20 options: - pi_cloud_instance_id: + pi_network_type: description: - - (Required for new resource) PI cloud instance ID + - (Required for new resource) PI network type required: True type: str + pi_dns: + description: + - List of PI network DNS name + required: False + type: list + elements: str pi_cidr: description: - PI network CIDR @@ -37,27 +43,21 @@ - PI network gateway required: False type: str + pi_network_name: + description: + - (Required for new resource) PI network name + required: True + type: str pi_network_jumbo: description: - PI network enable MTU Jumbo option required: False type: bool - pi_network_type: - description: - - (Required for new resource) PI network type - required: True - type: str - pi_network_name: + pi_cloud_instance_id: description: - - (Required for new resource) PI network name + - (Required for new resource) PI cloud instance ID required: True type: str - pi_dns: - description: - - List of PI network DNS name - required: False - type: list - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -100,31 +100,31 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_cloud_instance_id', 'str'), ('pi_network_type', 'str'), ('pi_network_name', 'str'), + ('pi_cloud_instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_cloud_instance_id', + 'pi_network_type', + 'pi_dns', 'pi_cidr', 'pi_gateway', - 'pi_network_jumbo', - 'pi_network_type', 'pi_network_name', - 'pi_dns', + 'pi_network_jumbo', + 'pi_cloud_instance_id', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('pi_network_name', 'str'), ('pi_cloud_instance_id', 'str'), + ('pi_network_name', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'pi_network_name', 'pi_cloud_instance_id', + 'pi_network_name', ] TL_CONFLICTS_MAP = { @@ -134,28 +134,28 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_cloud_instance_id=dict( + pi_network_type=dict( required=False, type='str'), + pi_dns=dict( + required=False, + elements='', + type='list'), pi_cidr=dict( required=False, type='str'), pi_gateway=dict( required=False, type='str'), + pi_network_name=dict( + required=False, + type='str'), pi_network_jumbo=dict( required=False, type='bool'), - pi_network_type=dict( - required=False, - type='str'), - pi_network_name=dict( + pi_cloud_instance_id=dict( required=False, type='str'), - pi_dns=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_pi_network_info.py b/plugins/modules/ibm_pi_network_info.py index 83830a604..d245ad60d 100644 --- a/plugins/modules/ibm_pi_network_info.py +++ b/plugins/modules/ibm_pi_network_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - pi_network_name: + pi_cloud_instance_id: description: - - Network Name to be used for pvminstances + - None required: True type: str - pi_cloud_instance_id: + pi_network_name: description: - - None + - Network Name to be used for pvminstances required: True type: str zone: @@ -60,14 +60,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_network_name', 'str'), ('pi_cloud_instance_id', 'str'), + ('pi_network_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_network_name', 'pi_cloud_instance_id', + 'pi_network_name', ] @@ -78,10 +78,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_network_name=dict( + pi_cloud_instance_id=dict( required=True, type='str'), - pi_cloud_instance_id=dict( + pi_network_name=dict( required=True, type='str'), zone=dict( diff --git a/plugins/modules/ibm_pi_network_port.py b/plugins/modules/ibm_pi_network_port.py index b7269936f..c43ec44b8 100644 --- a/plugins/modules/ibm_pi_network_port.py +++ b/plugins/modules/ibm_pi_network_port.py @@ -22,16 +22,6 @@ - Terraform v0.12.20 options: - pi_network_name: - description: - - (Required for new resource) - required: True - type: str - pi_cloud_instance_id: - description: - - (Required for new resource) - required: True - type: str pi_network_port_description: description: - None @@ -42,6 +32,16 @@ - None required: False type: str + pi_network_name: + description: + - (Required for new resource) + required: True + type: str + pi_cloud_instance_id: + description: + - (Required for new resource) + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -90,10 +90,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_network_name', - 'pi_cloud_instance_id', 'pi_network_port_description', 'pi_network_port_ipaddress', + 'pi_network_name', + 'pi_cloud_instance_id', ] # Params for Data source @@ -114,16 +114,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_network_name=dict( + pi_network_port_description=dict( required=False, type='str'), - pi_cloud_instance_id=dict( + pi_network_port_ipaddress=dict( required=False, type='str'), - pi_network_port_description=dict( + pi_network_name=dict( required=False, type='str'), - pi_network_port_ipaddress=dict( + pi_cloud_instance_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_network_port_attach.py b/plugins/modules/ibm_pi_network_port_attach.py index 2b03eb5cd..879bf2d64 100644 --- a/plugins/modules/ibm_pi_network_port_attach.py +++ b/plugins/modules/ibm_pi_network_port_attach.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + port_id: + description: + - (Required for new resource) + required: True + type: str + pi_cloud_instance_id: + description: + - (Required for new resource) + required: True + type: str pi_instance_name: description: - (Required for new resource) Instance name to attach the network port to @@ -38,16 +48,6 @@ required: False type: str default: Port Created via Terraform - port_id: - description: - - (Required for new resource) - required: True - type: str - pi_cloud_instance_id: - description: - - (Required for new resource) - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -90,19 +90,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_instance_name', 'str'), - ('pi_network_name', 'str'), ('port_id', 'str'), ('pi_cloud_instance_id', 'str'), + ('pi_instance_name', 'str'), + ('pi_network_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'port_id', + 'pi_cloud_instance_id', 'pi_instance_name', 'pi_network_name', 'pi_network_port_description', - 'port_id', - 'pi_cloud_instance_id', ] # Params for Data source @@ -119,19 +119,19 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_instance_name=dict( + port_id=dict( required=False, type='str'), - pi_network_name=dict( + pi_cloud_instance_id=dict( required=False, type='str'), - pi_network_port_description=dict( + pi_instance_name=dict( required=False, type='str'), - port_id=dict( + pi_network_name=dict( required=False, type='str'), - pi_cloud_instance_id=dict( + pi_network_port_description=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_operations.py b/plugins/modules/ibm_pi_operations.py index e8fafb705..19c9c1699 100644 --- a/plugins/modules/ibm_pi_operations.py +++ b/plugins/modules/ibm_pi_operations.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - pi_operation: - description: - - (Required for new resource) PI instance operation type - required: True - type: str pi_cloud_instance_id: description: - (Required for new resource) PI Cloud instnce id @@ -37,6 +32,11 @@ - (Required for new resource) PI instance Operation server name required: True type: str + pi_operation: + description: + - (Required for new resource) PI instance operation type + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -79,16 +79,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_operation', 'str'), ('pi_cloud_instance_id', 'str'), ('pi_instance_name', 'str'), + ('pi_operation', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_operation', 'pi_cloud_instance_id', 'pi_instance_name', + 'pi_operation', ] # Params for Data source @@ -105,15 +105,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_operation=dict( - required=False, - type='str'), pi_cloud_instance_id=dict( required=False, type='str'), pi_instance_name=dict( required=False, type='str'), + pi_operation=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_pi_placement_group.py b/plugins/modules/ibm_pi_placement_group.py index e350e7902..0f023d1dc 100644 --- a/plugins/modules/ibm_pi_placement_group.py +++ b/plugins/modules/ibm_pi_placement_group.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + pi_placement_group_name: + description: + - (Required for new resource) Name of the placement group + required: True + type: str pi_placement_group_policy: description: - (Required for new resource) Policy of the placement group @@ -32,11 +37,6 @@ - (Required for new resource) PI cloud instance ID required: True type: str - pi_placement_group_name: - description: - - (Required for new resource) Name of the placement group - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -79,27 +79,27 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('pi_placement_group_name', 'str'), ('pi_placement_group_policy', 'str'), ('pi_cloud_instance_id', 'str'), - ('pi_placement_group_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'pi_placement_group_name', 'pi_placement_group_policy', 'pi_cloud_instance_id', - 'pi_placement_group_name', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('pi_placement_group_name', 'str'), ('pi_cloud_instance_id', 'str'), + ('pi_placement_group_name', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'pi_placement_group_name', 'pi_cloud_instance_id', + 'pi_placement_group_name', ] TL_CONFLICTS_MAP = { @@ -109,13 +109,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_placement_group_policy=dict( + pi_placement_group_name=dict( required=False, type='str'), - pi_cloud_instance_id=dict( + pi_placement_group_policy=dict( required=False, type='str'), - pi_placement_group_name=dict( + pi_cloud_instance_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_placement_group_info.py b/plugins/modules/ibm_pi_placement_group_info.py index 3fea553cd..6dbaaf4a7 100644 --- a/plugins/modules/ibm_pi_placement_group_info.py +++ b/plugins/modules/ibm_pi_placement_group_info.py @@ -21,12 +21,12 @@ - Terraform v0.12.20 options: - pi_placement_group_name: + pi_cloud_instance_id: description: - None required: True type: str - pi_cloud_instance_id: + pi_placement_group_name: description: - None required: True @@ -60,14 +60,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_placement_group_name', 'str'), ('pi_cloud_instance_id', 'str'), + ('pi_placement_group_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_placement_group_name', 'pi_cloud_instance_id', + 'pi_placement_group_name', ] @@ -78,10 +78,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_placement_group_name=dict( + pi_cloud_instance_id=dict( required=True, type='str'), - pi_cloud_instance_id=dict( + pi_placement_group_name=dict( required=True, type='str'), zone=dict( diff --git a/plugins/modules/ibm_pi_snapshot.py b/plugins/modules/ibm_pi_snapshot.py index 1ada68c82..b92a02634 100644 --- a/plugins/modules/ibm_pi_snapshot.py +++ b/plugins/modules/ibm_pi_snapshot.py @@ -22,11 +22,12 @@ - Terraform v0.12.20 options: - pi_snap_shot_name: + pi_volume_ids: description: - - (Required for new resource) Unique name of the snapshot - required: True - type: str + - List of PI volumes + required: False + type: list + elements: str pi_cloud_instance_id: description: - (Required for new resource) Cloud Instance ID - This is the service_instance_id. @@ -37,17 +38,16 @@ - Description of the PVM instance snapshot required: False type: str + pi_snap_shot_name: + description: + - (Required for new resource) Unique name of the snapshot + required: True + type: str pi_instance_name: description: - (Required for new resource) Instance name / id of the pvm required: True type: str - pi_volume_ids: - description: - - List of PI volumes - required: False - type: list - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -90,18 +90,18 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_snap_shot_name', 'str'), ('pi_cloud_instance_id', 'str'), + ('pi_snap_shot_name', 'str'), ('pi_instance_name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_snap_shot_name', + 'pi_volume_ids', 'pi_cloud_instance_id', 'pi_description', + 'pi_snap_shot_name', 'pi_instance_name', - 'pi_volume_ids', ] # Params for Data source @@ -118,22 +118,22 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_snap_shot_name=dict( + pi_volume_ids=dict( required=False, - type='str'), + elements='', + type='list'), pi_cloud_instance_id=dict( required=False, type='str'), pi_description=dict( required=False, type='str'), - pi_instance_name=dict( + pi_snap_shot_name=dict( required=False, type='str'), - pi_volume_ids=dict( + pi_instance_name=dict( required=False, - elements='', - type='list'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_pi_volume.py b/plugins/modules/ibm_pi_volume.py index 00430942a..a2eb1b2c8 100644 --- a/plugins/modules/ibm_pi_volume.py +++ b/plugins/modules/ibm_pi_volume.py @@ -22,61 +22,61 @@ - Terraform v0.12.20 options: - pi_anti_affinity_volumes: + pi_volume_pool: description: - - List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided + - Volume pool where the volume will be created; if provided then pi_volume_type and pi_affinity_policy values will be ignored + required: False + type: str + pi_affinity_volume: + description: + - Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided + required: False + type: str + pi_anti_affinity_instances: + description: + - List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided required: False type: list elements: str - pi_cloud_instance_id: + pi_volume_name: description: - - (Required for new resource) Cloud Instance ID - This is the service_instance_id. + - (Required for new resource) Volume Name to create required: True type: str - pi_volume_type: + pi_volume_size: description: - - Type of Disk, required if pi_affinity_policy and pi_volume_pool not provided, otherwise ignored + - (Required for new resource) Size of the volume in GB + required: True + type: float + pi_affinity_instance: + description: + - PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided required: False type: str - pi_affinity_policy: + pi_cloud_instance_id: description: - - Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified - required: False + - (Required for new resource) Cloud Instance ID - This is the service_instance_id. + required: True type: str pi_volume_shareable: description: - Flag to indicate if the volume can be shared across multiple instances? required: False type: bool - pi_volume_size: - description: - - (Required for new resource) Size of the volume in GB - required: True - type: float - pi_volume_pool: + pi_volume_type: description: - - Volume pool where the volume will be created; if provided then pi_volume_type and pi_affinity_policy values will be ignored + - Type of Disk, required if pi_affinity_policy and pi_volume_pool not provided, otherwise ignored required: False type: str - pi_anti_affinity_instances: + pi_anti_affinity_volumes: description: - - List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_volumes is not provided + - List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and pi_anti_affinity_instances is not provided required: False type: list elements: str - pi_volume_name: - description: - - (Required for new resource) Volume Name to create - required: True - type: str - pi_affinity_volume: - description: - - Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_instance is not provided - required: False - type: str - pi_affinity_instance: + pi_affinity_policy: description: - - PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and pi_affinity_volume is not provided + - Affinity policy for data volume being created; ignored if pi_volume_pool provided; for policy affinity requires one of pi_affinity_instance or pi_affinity_volume to be specified; for policy anti-affinity requires one of pi_anti_affinity_instances or pi_anti_affinity_volumes to be specified required: False type: str id: @@ -121,24 +121,24 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_cloud_instance_id', 'str'), - ('pi_volume_size', 'float'), ('pi_volume_name', 'str'), + ('pi_volume_size', 'float'), + ('pi_cloud_instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_anti_affinity_volumes', - 'pi_cloud_instance_id', - 'pi_volume_type', - 'pi_affinity_policy', - 'pi_volume_shareable', - 'pi_volume_size', 'pi_volume_pool', + 'pi_affinity_volume', 'pi_anti_affinity_instances', 'pi_volume_name', - 'pi_affinity_volume', + 'pi_volume_size', 'pi_affinity_instance', + 'pi_cloud_instance_id', + 'pi_volume_shareable', + 'pi_volume_type', + 'pi_anti_affinity_volumes', + 'pi_affinity_policy', ] # Params for Data source @@ -153,49 +153,49 @@ ] TL_CONFLICTS_MAP = { - 'pi_anti_affinity_volumes': ['pi_anti_affinity_instances'], - 'pi_anti_affinity_instances': ['pi_anti_affinity_volumes'], 'pi_affinity_volume': ['pi_affinity_instance'], + 'pi_anti_affinity_instances': ['pi_anti_affinity_volumes'], 'pi_affinity_instance': ['pi_affinity_volume'], + 'pi_anti_affinity_volumes': ['pi_anti_affinity_instances'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_anti_affinity_volumes=dict( + pi_volume_pool=dict( + required=False, + type='str'), + pi_affinity_volume=dict( + required=False, + type='str'), + pi_anti_affinity_instances=dict( required=False, elements='', type='list'), - pi_cloud_instance_id=dict( + pi_volume_name=dict( required=False, type='str'), - pi_volume_type=dict( + pi_volume_size=dict( + required=False, + type='float'), + pi_affinity_instance=dict( required=False, type='str'), - pi_affinity_policy=dict( + pi_cloud_instance_id=dict( required=False, type='str'), pi_volume_shareable=dict( required=False, type='bool'), - pi_volume_size=dict( - required=False, - type='float'), - pi_volume_pool=dict( + pi_volume_type=dict( required=False, type='str'), - pi_anti_affinity_instances=dict( + pi_anti_affinity_volumes=dict( required=False, elements='', type='list'), - pi_volume_name=dict( - required=False, - type='str'), - pi_affinity_volume=dict( - required=False, - type='str'), - pi_affinity_instance=dict( + pi_affinity_policy=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_pi_vpn_connection.py b/plugins/modules/ibm_pi_vpn_connection.py index d7bdd5a8f..36696945c 100644 --- a/plugins/modules/ibm_pi_vpn_connection.py +++ b/plugins/modules/ibm_pi_vpn_connection.py @@ -22,29 +22,31 @@ - Terraform v0.12.20 options: - pi_cloud_instance_id: + pi_peer_subnets: description: - - (Required for new resource) PI cloud instance ID + - (Required for new resource) Set of CIDR of peer subnets required: True - type: str - pi_vpn_connection_name: + type: list + elements: str + pi_networks: description: - - (Required for new resource) Name of the VPN Connection + - (Required for new resource) Set of network IDs to attach to this VPN connection required: True - type: str - pi_ipsec_policy_id: + type: list + elements: str + pi_vpn_connection_name: description: - - (Required for new resource) Unique identifier of IPSec Policy selected for this VPN Connection + - (Required for new resource) Name of the VPN Connection required: True type: str - pi_peer_gateway_address: + pi_ike_policy_id: description: - - (Required for new resource) Peer Gateway address + - (Required for new resource) Unique identifier of IKE Policy selected for this VPN Connection required: True type: str - pi_ike_policy_id: + pi_ipsec_policy_id: description: - - (Required for new resource) Unique identifier of IKE Policy selected for this VPN Connection + - (Required for new resource) Unique identifier of IPSec Policy selected for this VPN Connection required: True type: str pi_vpn_connection_mode: @@ -52,18 +54,16 @@ - (Required for new resource) Mode used by this VPN Connection, either 'policy' or 'route' required: True type: str - pi_networks: + pi_peer_gateway_address: description: - - (Required for new resource) Set of network IDs to attach to this VPN connection + - (Required for new resource) Peer Gateway address required: True - type: list - elements: str - pi_peer_subnets: + type: str + pi_cloud_instance_id: description: - - (Required for new resource) Set of CIDR of peer subnets + - (Required for new resource) PI cloud instance ID required: True - type: list - elements: str + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -106,26 +106,26 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('pi_cloud_instance_id', 'str'), + ('pi_peer_subnets', 'list'), + ('pi_networks', 'list'), ('pi_vpn_connection_name', 'str'), - ('pi_ipsec_policy_id', 'str'), - ('pi_peer_gateway_address', 'str'), ('pi_ike_policy_id', 'str'), + ('pi_ipsec_policy_id', 'str'), ('pi_vpn_connection_mode', 'str'), - ('pi_networks', 'list'), - ('pi_peer_subnets', 'list'), + ('pi_peer_gateway_address', 'str'), + ('pi_cloud_instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'pi_cloud_instance_id', + 'pi_peer_subnets', + 'pi_networks', 'pi_vpn_connection_name', - 'pi_ipsec_policy_id', - 'pi_peer_gateway_address', 'pi_ike_policy_id', + 'pi_ipsec_policy_id', 'pi_vpn_connection_mode', - 'pi_networks', - 'pi_peer_subnets', + 'pi_peer_gateway_address', + 'pi_cloud_instance_id', ] # Params for Data source @@ -142,32 +142,32 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - pi_cloud_instance_id=dict( + pi_peer_subnets=dict( required=False, - type='str'), - pi_vpn_connection_name=dict( + elements='', + type='list'), + pi_networks=dict( required=False, - type='str'), - pi_ipsec_policy_id=dict( + elements='', + type='list'), + pi_vpn_connection_name=dict( required=False, type='str'), - pi_peer_gateway_address=dict( + pi_ike_policy_id=dict( required=False, type='str'), - pi_ike_policy_id=dict( + pi_ipsec_policy_id=dict( required=False, type='str'), pi_vpn_connection_mode=dict( required=False, type='str'), - pi_networks=dict( + pi_peer_gateway_address=dict( required=False, - elements='', - type='list'), - pi_peer_subnets=dict( + type='str'), + pi_cloud_instance_id=dict( required=False, - elements='', - type='list'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_pn_application_chrome.py b/plugins/modules/ibm_pn_application_chrome.py index 4ca1a27d8..6b7a25cb0 100644 --- a/plugins/modules/ibm_pn_application_chrome.py +++ b/plugins/modules/ibm_pn_application_chrome.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + web_site_url: + description: + - (Required for new resource) The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush. + required: True + type: str guid: description: - (Required for new resource) Unique guid of the push notification instance. @@ -32,11 +37,6 @@ - (Required for new resource) A server key that gives the push service an authorized access to Google services that is used for Chrome Web Push. required: True type: str - web_site_url: - description: - - (Required for new resource) The URL of the WebSite / WebApp that should be permitted to subscribe to WebPush. - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -83,16 +83,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('web_site_url', 'str'), ('guid', 'str'), ('server_key', 'str'), - ('web_site_url', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'web_site_url', 'guid', 'server_key', - 'web_site_url', ] # Params for Data source @@ -111,13 +111,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - guid=dict( + web_site_url=dict( required=False, type='str'), - server_key=dict( + guid=dict( required=False, type='str'), - web_site_url=dict( + server_key=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_resource_instance.py b/plugins/modules/ibm_resource_instance.py index c0c05f96e..d20414705 100644 --- a/plugins/modules/ibm_resource_instance.py +++ b/plugins/modules/ibm_resource_instance.py @@ -22,40 +22,19 @@ - Terraform v0.12.20 options: - parameters: - description: - - Arbitrary parameters to pass. Must be a JSON object - required: False - type: dict - location: - description: - - (Required for new resource) The location where the instance available - required: True - type: str - tags: - description: - - None - required: False - type: list - elements: str - service_endpoints: - description: - - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. - required: False - type: str name: description: - (Required for new resource) A name for the resource instance required: True type: str - service: + plan: description: - - (Required for new resource) The name of the service offering like cloud-object-storage, kms etc + - (Required for new resource) The plan type of the service required: True type: str - plan: + service: description: - - (Required for new resource) The plan type of the service + - (Required for new resource) The name of the service offering like cloud-object-storage, kms etc required: True type: str resource_group_id: @@ -63,11 +42,32 @@ - The resource group id required: False type: str + parameters: + description: + - Arbitrary parameters to pass. Must be a JSON object + required: False + type: dict parameters_json: description: - Arbitrary parameters to pass in Json string format required: False type: str + service_endpoints: + description: + - Types of the service endpoints. Possible values are 'public', 'private', 'public-and-private'. + required: False + type: str + tags: + description: + - None + required: False + type: list + elements: str + location: + description: + - (Required for new resource) The location where the instance available + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -114,23 +114,23 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('location', 'str'), ('name', 'str'), - ('service', 'str'), ('plan', 'str'), + ('service', 'str'), + ('location', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'parameters', - 'location', - 'tags', - 'service_endpoints', 'name', - 'service', 'plan', + 'service', 'resource_group_id', + 'parameters', 'parameters_json', + 'service_endpoints', + 'tags', + 'location', ] # Params for Data source @@ -139,10 +139,10 @@ ] TL_ALL_PARAMETERS_DS = [ + 'name', 'location', 'service', 'resource_group_id', - 'name', ] TL_CONFLICTS_MAP = { @@ -154,32 +154,32 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - parameters=dict( - required=False, - type='dict'), - location=dict( + name=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), - service_endpoints=dict( + plan=dict( required=False, type='str'), - name=dict( + service=dict( required=False, type='str'), - service=dict( + resource_group_id=dict( required=False, type='str'), - plan=dict( + parameters=dict( + required=False, + type='dict'), + parameters_json=dict( required=False, type='str'), - resource_group_id=dict( + service_endpoints=dict( required=False, type='str'), - parameters_json=dict( + tags=dict( + required=False, + elements='', + type='list'), + location=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_resource_instance_info.py b/plugins/modules/ibm_resource_instance_info.py index 3b9aee11c..81b01ea54 100644 --- a/plugins/modules/ibm_resource_instance_info.py +++ b/plugins/modules/ibm_resource_instance_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + name: + description: + - Resource instance name for example, myobjectstorage + required: True + type: str location: description: - The location or the environment in which instance exists @@ -36,11 +41,6 @@ - The id of the resource group in which the instance is present required: False type: str - name: - description: - - Resource instance name for example, myobjectstorage - required: True - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -79,10 +79,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'name', 'location', 'service', 'resource_group_id', - 'name', ] @@ -93,6 +93,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + name=dict( + required=True, + type='str'), location=dict( required=False, type='str'), @@ -102,9 +105,6 @@ resource_group_id=dict( required=False, type='str'), - name=dict( - required=True, - type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_resource_key.py b/plugins/modules/ibm_resource_key.py index 13553a0eb..3c5bda186 100644 --- a/plugins/modules/ibm_resource_key.py +++ b/plugins/modules/ibm_resource_key.py @@ -22,22 +22,16 @@ - Terraform v0.12.20 options: - tags: - description: - - None - required: False - type: list - elements: str - resource_instance_id: - description: - - The id of the resource instance for which to create resource key - required: False - type: str name: description: - (Required for new resource) The name of the resource key required: True type: str + resource_alias_id: + description: + - The id of the resource alias for which to create resource key + required: False + type: str parameters: description: - Arbitrary parameters to pass. Must be a JSON object @@ -48,11 +42,17 @@ - Name of the user role.Valid roles are Writer, Reader, Manager, Administrator, Operator, Viewer, Editor and Custom Roles. required: False type: str - resource_alias_id: + resource_instance_id: description: - - The id of the resource alias for which to create resource key + - The id of the resource instance for which to create resource key required: False type: str + tags: + description: + - None + required: False + type: list + elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -104,12 +104,12 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'tags', - 'resource_instance_id', 'name', + 'resource_alias_id', 'parameters', 'role', - 'resource_alias_id', + 'resource_instance_id', + 'tags', ] # Params for Data source @@ -118,29 +118,25 @@ ] TL_ALL_PARAMETERS_DS = [ + 'name', 'resource_instance_id', 'resource_alias_id', 'most_recent', - 'name', ] TL_CONFLICTS_MAP = { - 'resource_instance_id': ['resource_alias_id'], 'resource_alias_id': ['resource_instance_id'], + 'resource_instance_id': ['resource_alias_id'], } # define available arguments/parameters a user can pass to the module from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - tags=dict( - required=False, - elements='', - type='list'), - resource_instance_id=dict( + name=dict( required=False, type='str'), - name=dict( + resource_alias_id=dict( required=False, type='str'), parameters=dict( @@ -149,9 +145,13 @@ role=dict( required=False, type='str'), - resource_alias_id=dict( + resource_instance_id=dict( required=False, type='str'), + tags=dict( + required=False, + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_resource_key_info.py b/plugins/modules/ibm_resource_key_info.py index 860aa4bcd..a350f7451 100644 --- a/plugins/modules/ibm_resource_key_info.py +++ b/plugins/modules/ibm_resource_key_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + name: + description: + - The name of the resource key + required: True + type: str resource_instance_id: description: - The id of the resource instance @@ -37,11 +42,6 @@ required: False type: bool default: False - name: - description: - - The name of the resource key - required: True - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -80,10 +80,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'name', 'resource_instance_id', 'resource_alias_id', 'most_recent', - 'name', ] @@ -96,6 +96,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + name=dict( + required=True, + type='str'), resource_instance_id=dict( required=False, type='str'), @@ -105,9 +108,6 @@ most_recent=dict( required=False, type='bool'), - name=dict( - required=True, - type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_resource_tag.py b/plugins/modules/ibm_resource_tag.py index d0a67ae9c..6878562ab 100644 --- a/plugins/modules/ibm_resource_tag.py +++ b/plugins/modules/ibm_resource_tag.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + tag_type: + description: + - Type of the tag. Only allowed values are: user, or service or access (default value : user) + required: False + type: str resource_id: description: - (Required for new resource) CRN of the resource on which the tags should be attached @@ -38,11 +43,6 @@ - Resource type on which the tags should be attached required: False type: str - tag_type: - description: - - Type of the tag. Only allowed values are: user, or service or access (default value : user) - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -94,10 +94,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'tag_type', 'resource_id', 'tags', 'resource_type', - 'tag_type', ] # Params for Data source @@ -105,9 +105,9 @@ ] TL_ALL_PARAMETERS_DS = [ + 'resource_type', 'tag_type', 'resource_id', - 'resource_type', ] TL_CONFLICTS_MAP = { @@ -117,6 +117,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + tag_type=dict( + required=False, + type='str'), resource_id=dict( required=False, type='str'), @@ -127,9 +130,6 @@ resource_type=dict( required=False, type='str'), - tag_type=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_resource_tag_info.py b/plugins/modules/ibm_resource_tag_info.py index b9cca2d12..3c63ce607 100644 --- a/plugins/modules/ibm_resource_tag_info.py +++ b/plugins/modules/ibm_resource_tag_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + resource_type: + description: + - Resource type on which the tags should be fetched + required: False + type: str tag_type: description: - Tag type on which the tags should be fetched @@ -32,11 +37,6 @@ - CRN of the resource on which the tags should be attached required: False type: str - resource_type: - description: - - Resource type on which the tags should be fetched - required: False - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -74,9 +74,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'resource_type', 'tag_type', 'resource_id', - 'resource_type', ] @@ -87,13 +87,13 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - tag_type=dict( + resource_type=dict( required=False, type='str'), - resource_id=dict( + tag_type=dict( required=False, type='str'), - resource_type=dict( + resource_id=dict( required=False, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_satellite_attach_host_script_info.py b/plugins/modules/ibm_satellite_attach_host_script_info.py index d7daebc80..dfbb08501 100644 --- a/plugins/modules/ibm_satellite_attach_host_script_info.py +++ b/plugins/modules/ibm_satellite_attach_host_script_info.py @@ -21,11 +21,6 @@ - Terraform v0.12.20 options: - location: - description: - - A unique name for the new Satellite location - required: True - type: str labels: description: - List of labels for the attach host @@ -42,6 +37,11 @@ - The directory where the satellite attach host script to be downloaded. Default is home directory required: False type: str + location: + description: + - A unique name for the new Satellite location + required: True + type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -75,16 +75,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('location', 'str'), ('host_provider', 'str'), + ('location', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'location', 'labels', 'host_provider', 'script_dir', + 'location', ] @@ -95,9 +95,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - location=dict( - required=True, - type='str'), labels=dict( required=False, elements='', @@ -108,6 +105,9 @@ script_dir=dict( required=False, type='str'), + location=dict( + required=True, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_satellite_cluster.py b/plugins/modules/ibm_satellite_cluster.py index 3b2194ec3..6c69a18a8 100644 --- a/plugins/modules/ibm_satellite_cluster.py +++ b/plugins/modules/ibm_satellite_cluster.py @@ -22,19 +22,39 @@ - Terraform v0.12.20 options: + name: + description: + - (Required for new resource) The unique name for the new IBM Cloud Satellite cluster + required: True + type: str + retry_patch_version: + description: + - Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails + required: False + type: int + worker_count: + description: + - The number of worker nodes per zone in the default worker pool. Required when '--host-label' is specified. (default: 0) + required: False + type: int pull_secret: description: - The RedHat pull secret to create the OpenShift cluster required: False type: str - pod_subnet: + patch_version: description: - - User provided value for the pod subnet + - Kubernetes patch version required: False type: str - resource_group_id: + enable_config_admin: description: - - ID of the resource group. + - Grant cluster admin access to Satellite Config to manage Kubernetes resources. + required: False + type: bool + service_subnet: + description: + - User provided value for service subnet required: False type: str tags: @@ -43,20 +63,25 @@ required: False type: list elements: str - retry_patch_version: + resource_group_id: description: - - Argument which helps to retry the patch version updates on worker nodes. Increment the value to retry the patch updates if the previous apply fails + - ID of the resource group. required: False - type: int + type: str + location: + description: + - (Required for new resource) The name or ID of the Satellite location + required: True + type: str zones: description: - Zone info for worker pool required: False type: list elements: dict - service_subnet: + kube_version: description: - - User provided value for service subnet + - The OpenShift Container Platform version required: False type: str host_labels: @@ -65,59 +90,34 @@ required: False type: list elements: str - wait_for_worker_update: + crn_token: description: - - Wait for worker node to update during kube version update. + - The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster. required: False - type: bool - default: True + type: str default_worker_pool_labels: description: - Labels on the default worker pool required: False type: dict elements: str - enable_config_admin: + pod_subnet: description: - - Grant cluster admin access to Satellite Config to manage Kubernetes resources. + - User provided value for the pod subnet + required: False + type: str + wait_for_worker_update: + description: + - Wait for worker node to update during kube version update. required: False type: bool + default: True disable_public_service_endpoint: description: - Boolean value true if Public service endpoint to be disabled required: False type: bool default: False - name: - description: - - (Required for new resource) The unique name for the new IBM Cloud Satellite cluster - required: True - type: str - patch_version: - description: - - Kubernetes patch version - required: False - type: str - location: - description: - - (Required for new resource) The name or ID of the Satellite location - required: True - type: str - crn_token: - description: - - The IBM Cloud Identity and Access Management (IAM) service CRN token for the service that creates the cluster. - required: False - type: str - kube_version: - description: - - The OpenShift Container Platform version - required: False - type: str - worker_count: - description: - - The number of worker nodes per zone in the default worker pool. Required when '--host-label' is specified. (default: 0) - required: False - type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -170,24 +170,24 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'name', + 'retry_patch_version', + 'worker_count', 'pull_secret', - 'pod_subnet', - 'resource_group_id', + 'patch_version', + 'enable_config_admin', + 'service_subnet', 'tags', - 'retry_patch_version', + 'resource_group_id', + 'location', 'zones', - 'service_subnet', + 'kube_version', 'host_labels', - 'wait_for_worker_update', + 'crn_token', 'default_worker_pool_labels', - 'enable_config_admin', + 'pod_subnet', + 'wait_for_worker_update', 'disable_public_service_endpoint', - 'name', - 'patch_version', - 'location', - 'crn_token', - 'kube_version', - 'worker_count', ] # Params for Data source @@ -207,64 +207,64 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + name=dict( + required=False, + type='str'), + retry_patch_version=dict( + required=False, + type='int'), + worker_count=dict( + required=False, + type='int'), pull_secret=dict( required=False, type='str'), - pod_subnet=dict( + patch_version=dict( required=False, type='str'), - resource_group_id=dict( + enable_config_admin=dict( + required=False, + type='bool'), + service_subnet=dict( required=False, type='str'), tags=dict( required=False, elements='', type='list'), - retry_patch_version=dict( + resource_group_id=dict( required=False, - type='int'), + type='str'), + location=dict( + required=False, + type='str'), zones=dict( required=False, elements='', type='list'), - service_subnet=dict( + kube_version=dict( required=False, type='str'), host_labels=dict( required=False, elements='', type='list'), - wait_for_worker_update=dict( + crn_token=dict( required=False, - type='bool'), + type='str'), default_worker_pool_labels=dict( required=False, elements='', type='dict'), - enable_config_admin=dict( + pod_subnet=dict( + required=False, + type='str'), + wait_for_worker_update=dict( required=False, type='bool'), disable_public_service_endpoint=dict( required=False, type='bool'), - name=dict( - required=False, - type='str'), - patch_version=dict( - required=False, - type='str'), - location=dict( - required=False, - type='str'), - crn_token=dict( - required=False, - type='str'), - kube_version=dict( - required=False, - type='str'), - worker_count=dict( - required=False, - type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_satellite_cluster_worker_pool.py b/plugins/modules/ibm_satellite_cluster_worker_pool.py index 08daecf3b..c3cdbea65 100644 --- a/plugins/modules/ibm_satellite_cluster_worker_pool.py +++ b/plugins/modules/ibm_satellite_cluster_worker_pool.py @@ -22,18 +22,32 @@ - Terraform v0.12.20 options: + flavor: + description: + - The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node + required: False + type: str + disk_encryption: + description: + - Disk encryption for worker node + required: False + type: bool + worker_count: + description: + - Specify the desired number of workers per zone in this worker pool + required: False + type: int zones: description: - Zone info for worker pool required: False type: list elements: dict - host_labels: + resource_group_id: description: - - Labels that describe a Satellite host + - ID of the resource group. required: False - type: list - elements: str + type: str name: description: - (Required for new resource) The name for the worker pool @@ -44,26 +58,11 @@ - (Required for new resource) The unique name for the new IBM Cloud Satellite cluster required: True type: str - flavor: - description: - - The flavor defines the amount of virtual CPU, memory, and disk space that is set up in each worker node - required: False - type: str - disk_encryption: - description: - - Disk encryption for worker node - required: False - type: bool isolation: description: - None required: False type: str - worker_count: - description: - - Specify the desired number of workers per zone in this worker pool - required: False - type: int entitlement: description: - None @@ -75,11 +74,12 @@ required: False type: dict elements: str - resource_group_id: + host_labels: description: - - ID of the resource group. + - Labels that describe a Satellite host required: False - type: str + type: list + elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -132,17 +132,17 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'flavor', + 'disk_encryption', + 'worker_count', 'zones', - 'host_labels', + 'resource_group_id', 'name', 'cluster', - 'flavor', - 'disk_encryption', 'isolation', - 'worker_count', 'entitlement', 'worker_pool_labels', - 'resource_group_id', + 'host_labels', ] # Params for Data source @@ -152,10 +152,10 @@ ] TL_ALL_PARAMETERS_DS = [ - 'region', 'name', - 'resource_group_id', 'cluster', + 'resource_group_id', + 'region', ] TL_CONFLICTS_MAP = { @@ -165,32 +165,31 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + flavor=dict( + required=False, + type='str'), + disk_encryption=dict( + required=False, + type='bool'), + worker_count=dict( + required=False, + type='int'), zones=dict( required=False, elements='', type='list'), - host_labels=dict( + resource_group_id=dict( required=False, - elements='', - type='list'), + type='str'), name=dict( required=False, type='str'), cluster=dict( required=False, type='str'), - flavor=dict( - required=False, - type='str'), - disk_encryption=dict( - required=False, - type='bool'), isolation=dict( required=False, type='str'), - worker_count=dict( - required=False, - type='int'), entitlement=dict( required=False, type='str'), @@ -198,9 +197,10 @@ required=False, elements='', type='dict'), - resource_group_id=dict( + host_labels=dict( required=False, - type='str'), + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_satellite_cluster_worker_pool_info.py b/plugins/modules/ibm_satellite_cluster_worker_pool_info.py index 05559e9fe..13fd9f26d 100644 --- a/plugins/modules/ibm_satellite_cluster_worker_pool_info.py +++ b/plugins/modules/ibm_satellite_cluster_worker_pool_info.py @@ -21,25 +21,25 @@ - Terraform v0.12.20 options: - region: - description: - - Name of the region - required: False - type: str name: description: - worker pool name required: True type: str + cluster: + description: + - Cluster name + required: True + type: str resource_group_id: description: - ID of the resource group required: False type: str - cluster: + region: description: - - Cluster name - required: True + - Name of the region + required: False type: str iaas_classic_username: description: @@ -80,10 +80,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'region', 'name', - 'resource_group_id', 'cluster', + 'resource_group_id', + 'region', ] @@ -94,17 +94,17 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - region=dict( - required=False, - type='str'), name=dict( required=True, type='str'), + cluster=dict( + required=True, + type='str'), resource_group_id=dict( required=False, type='str'), - cluster=dict( - required=True, + region=dict( + required=False, type='str'), iaas_classic_username=dict( type='str', diff --git a/plugins/modules/ibm_satellite_cluster_worker_pool_zone_attachment.py b/plugins/modules/ibm_satellite_cluster_worker_pool_zone_attachment.py index 1b50ba8e9..5032f4ee1 100644 --- a/plugins/modules/ibm_satellite_cluster_worker_pool_zone_attachment.py +++ b/plugins/modules/ibm_satellite_cluster_worker_pool_zone_attachment.py @@ -103,16 +103,16 @@ # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('zone', 'str'), ('cluster', 'str'), ('worker_pool', 'str'), + ('zone', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'zone', - 'resource_group_id', 'cluster', 'worker_pool', + 'zone', + 'resource_group_id', ] TL_CONFLICTS_MAP = { diff --git a/plugins/modules/ibm_satellite_cluster_worker_pool_zone_attachment_info.py b/plugins/modules/ibm_satellite_cluster_worker_pool_zone_attachment_info.py index b2d4ffe30..f68b07523 100644 --- a/plugins/modules/ibm_satellite_cluster_worker_pool_zone_attachment_info.py +++ b/plugins/modules/ibm_satellite_cluster_worker_pool_zone_attachment_info.py @@ -21,16 +21,6 @@ - Terraform v0.12.20 options: - zone: - description: - - worker pool zone name - required: True - type: str - resource_group_id: - description: - - The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method. - required: False - type: str cluster: description: - Name or id of the cluster @@ -41,6 +31,16 @@ - worker pool name required: True type: str + zone: + description: + - worker pool zone name + required: True + type: str + resource_group_id: + description: + - The ID of the resource group that the Satellite location is in. To list the resource group ID of the location, use the `GET /v2/satellite/getController` API method. + required: False + type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -74,17 +74,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('zone', 'str'), ('cluster', 'str'), ('worker_pool', 'str'), + ('zone', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'zone', - 'resource_group_id', 'cluster', 'worker_pool', + 'zone', + 'resource_group_id', ] @@ -95,18 +95,18 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - zone=dict( - required=True, - type='str'), - resource_group_id=dict( - required=False, - type='str'), cluster=dict( required=True, type='str'), worker_pool=dict( required=True, type='str'), + zone=dict( + required=True, + type='str'), + resource_group_id=dict( + required=False, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_satellite_endpoint.py b/plugins/modules/ibm_satellite_endpoint.py index 3da8e2677..28a0fafa5 100644 --- a/plugins/modules/ibm_satellite_endpoint.py +++ b/plugins/modules/ibm_satellite_endpoint.py @@ -22,11 +22,12 @@ - Terraform v0.12.20 options: - timeout: + server_mutual_auth: description: - - The inactivity timeout in the Endpoint side. + - Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required. required: False - type: int + type: bool + default: False location: description: - (Required for new resource) The Location ID. @@ -37,29 +38,35 @@ - (Required for new resource) The type of the endpoint. required: True type: str - server_host: + display_name: description: - - (Required for new resource) The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '*.' , which means a wildcard to it's sub domains. Such as '*.example.com' can accept request to 'api.example.com' and 'www.example.com'. + - (Required for new resource) The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer. required: True type: str - server_port: + sni: description: - - (Required for new resource) The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https). - required: True - type: int - server_protocol: + - The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI. + required: False + type: str + created_by: description: - - The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'. + - The service or person who created the endpoint. Must be 1000 characters or fewer. required: False type: str - display_name: + certs: description: - - (Required for new resource) The display name of the endpoint. Endpoint names must start with a letter and end with an alphanumeric character, can contain letters, numbers, and hyphen (-), and must be 63 characters or fewer. + - The certs. + required: False + type: list + elements: dict + client_protocol: + description: + - (Required for new resource) The protocol in the client application side. required: True type: str - server_mutual_auth: + client_mutual_auth: description: - - Whether enable mutual auth in the server application side, when client_protocol is 'tls', this field is required. + - Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required. required: False type: bool default: False @@ -69,33 +76,26 @@ required: False type: bool default: False - created_by: + server_host: description: - - The service or person who created the endpoint. Must be 1000 characters or fewer. - required: False + - (Required for new resource) The host name or IP address of the server endpoint. For 'http-tunnel' protocol, server_host can start with '*.' , which means a wildcard to it's sub domains. Such as '*.example.com' can accept request to 'api.example.com' and 'www.example.com'. + required: True type: str - client_mutual_auth: - description: - - Whether enable mutual auth in the client application side, when client_protocol is 'tls' or 'https', this field is required. - required: False - type: bool - default: False - certs: + server_port: description: - - The certs. - required: False - type: list - elements: dict - sni: + - (Required for new resource) The port number of the server endpoint. For 'http-tunnel' protocol, server_port can be 0, which means any port. Such as 0 is good for 80 (http) and 443 (https). + required: True + type: int + server_protocol: description: - - The server name indicator (SNI) which used to connect to the server endpoint. Only useful if server side requires SNI. + - The protocol in the server application side. This parameter will change to default value if it is omitted even when using PATCH API. If client_protocol is 'udp', server_protocol must be 'udp'. If client_protocol is 'tcp'/'http', server_protocol could be 'tcp'/'tls' and default to 'tcp'. If client_protocol is 'tls'/'https', server_protocol could be 'tcp'/'tls' and default to 'tls'. If client_protocol is 'http-tunnel', server_protocol must be 'tcp'. required: False type: str - client_protocol: + timeout: description: - - (Required for new resource) The protocol in the client application side. - required: True - type: str + - The inactivity timeout in the Endpoint side. + required: False + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -144,39 +144,39 @@ TL_REQUIRED_PARAMETERS = [ ('location', 'str'), ('connection_type', 'str'), - ('server_host', 'str'), - ('server_port', 'int'), ('display_name', 'str'), ('client_protocol', 'str'), + ('server_host', 'str'), + ('server_port', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'timeout', + 'server_mutual_auth', 'location', 'connection_type', - 'server_host', - 'server_port', - 'server_protocol', 'display_name', - 'server_mutual_auth', - 'reject_unauth', + 'sni', 'created_by', - 'client_mutual_auth', 'certs', - 'sni', 'client_protocol', + 'client_mutual_auth', + 'reject_unauth', + 'server_host', + 'server_port', + 'server_protocol', + 'timeout', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('location', 'str'), ('endpoint_id', 'str'), + ('location', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'location', 'endpoint_id', + 'location', ] TL_CONFLICTS_MAP = { @@ -186,49 +186,49 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - timeout=dict( + server_mutual_auth=dict( required=False, - type='int'), + type='bool'), location=dict( required=False, type='str'), connection_type=dict( required=False, type='str'), - server_host=dict( + display_name=dict( required=False, type='str'), - server_port=dict( + sni=dict( required=False, - type='int'), - server_protocol=dict( + type='str'), + created_by=dict( required=False, type='str'), - display_name=dict( + certs=dict( + required=False, + elements='', + type='list'), + client_protocol=dict( required=False, type='str'), - server_mutual_auth=dict( + client_mutual_auth=dict( required=False, type='bool'), reject_unauth=dict( required=False, type='bool'), - created_by=dict( + server_host=dict( required=False, type='str'), - client_mutual_auth=dict( - required=False, - type='bool'), - certs=dict( + server_port=dict( required=False, - elements='', - type='list'), - sni=dict( + type='int'), + server_protocol=dict( required=False, type='str'), - client_protocol=dict( + timeout=dict( required=False, - type='str'), + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_satellite_endpoint_info.py b/plugins/modules/ibm_satellite_endpoint_info.py index 3e1add655..31e9477ad 100644 --- a/plugins/modules/ibm_satellite_endpoint_info.py +++ b/plugins/modules/ibm_satellite_endpoint_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - location: + endpoint_id: description: - - The Location ID. + - The Endpoint ID. required: True type: str - endpoint_id: + location: description: - - The Endpoint ID. + - The Location ID. required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('location', 'str'), ('endpoint_id', 'str'), + ('location', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'location', 'endpoint_id', + 'location', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - location=dict( + endpoint_id=dict( required=True, type='str'), - endpoint_id=dict( + location=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_satellite_host.py b/plugins/modules/ibm_satellite_host.py index 32cd9374a..5874dc211 100644 --- a/plugins/modules/ibm_satellite_host.py +++ b/plugins/modules/ibm_satellite_host.py @@ -22,6 +22,16 @@ - Terraform v0.12.20 options: + zone: + description: + - The zone within the cluster to assign the host to + required: False + type: str + worker_pool: + description: + - The name or ID of the worker pool within the cluster to assign the host to + required: False + type: str host_provider: description: - Host Provider @@ -48,16 +58,6 @@ required: False type: list elements: str - zone: - description: - - The zone within the cluster to assign the host to - required: False - type: str - worker_pool: - description: - - The name or ID of the worker pool within the cluster to assign the host to - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -110,13 +110,13 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'zone', + 'worker_pool', 'host_provider', 'location', 'cluster', 'host_id', 'labels', - 'zone', - 'worker_pool', ] # Params for Data source @@ -133,6 +133,12 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + zone=dict( + required=False, + type='str'), + worker_pool=dict( + required=False, + type='str'), host_provider=dict( required=False, type='str'), @@ -149,12 +155,6 @@ required=False, elements='', type='list'), - zone=dict( - required=False, - type='str'), - worker_pool=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_satellite_link.py b/plugins/modules/ibm_satellite_link.py index b0793661c..253a9f8b1 100644 --- a/plugins/modules/ibm_satellite_link.py +++ b/plugins/modules/ibm_satellite_link.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - crn: - description: - - (Required for new resource) CRN of the Location. - required: True - type: str location: description: - (Required for new resource) Location ID. @@ -37,6 +32,11 @@ - The ws endpoint of the location. required: False type: str + crn: + description: + - (Required for new resource) CRN of the Location. + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -83,15 +83,15 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('crn', 'str'), ('location', 'str'), + ('crn', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'crn', 'location', 'ws_endpoint', + 'crn', ] # Params for Data source @@ -110,15 +110,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - crn=dict( - required=False, - type='str'), location=dict( required=False, type='str'), ws_endpoint=dict( required=False, type='str'), + crn=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_satellite_location.py b/plugins/modules/ibm_satellite_location.py index 40418a16c..06d657595 100644 --- a/plugins/modules/ibm_satellite_location.py +++ b/plugins/modules/ibm_satellite_location.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + location: + description: + - (Required for new resource) A unique name for the new Satellite location + required: True + type: str managed_from: description: - (Required for new resource) The IBM Cloud metro from which the Satellite location is managed @@ -32,39 +37,34 @@ - The account ID for IBM Log Analysis with LogDNA log forwarding required: False type: str - description: - description: - - A description of the new Satellite location - required: False - type: str - cos_config: + cos_credentials: description: - - COSBucket - IBM Cloud Object Storage bucket configuration details + - COSAuthorization - IBM Cloud Object Storage authorization keys required: False type: list elements: dict - cos_credentials: + tags: description: - - COSAuthorization - IBM Cloud Object Storage authorization keys + - List of tags associated with resource instance required: False type: list - elements: dict + elements: str + description: + description: + - A description of the new Satellite location + required: False + type: str resource_group_id: description: - ID of the resource group. required: False type: str - tags: + cos_config: description: - - List of tags associated with resource instance + - COSBucket - IBM Cloud Object Storage bucket configuration details required: False type: list - elements: str - location: - description: - - (Required for new resource) A unique name for the new Satellite location - required: True - type: str + elements: dict zones: description: - The names of at least three high availability zones to use for the location @@ -117,20 +117,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('managed_from', 'str'), ('location', 'str'), + ('managed_from', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'location', 'managed_from', 'logging_account_id', - 'description', - 'cos_config', 'cos_credentials', - 'resource_group_id', 'tags', - 'location', + 'description', + 'resource_group_id', + 'cos_config', 'zones', ] @@ -150,33 +150,33 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - managed_from=dict( + location=dict( required=False, type='str'), - logging_account_id=dict( + managed_from=dict( required=False, type='str'), - description=dict( + logging_account_id=dict( required=False, type='str'), - cos_config=dict( + cos_credentials=dict( required=False, elements='', type='list'), - cos_credentials=dict( + tags=dict( required=False, elements='', type='list'), + description=dict( + required=False, + type='str'), resource_group_id=dict( required=False, type='str'), - tags=dict( + cos_config=dict( required=False, elements='', type='list'), - location=dict( - required=False, - type='str'), zones=dict( required=False, elements='', diff --git a/plugins/modules/ibm_scc_posture_collector.py b/plugins/modules/ibm_scc_posture_collector.py index 6e27c6843..0abbd6420 100644 --- a/plugins/modules/ibm_scc_posture_collector.py +++ b/plugins/modules/ibm_scc_posture_collector.py @@ -22,6 +22,21 @@ - Terraform v0.12.20 options: + passphrase: + description: + - To protect the credentials that you add to the service, a passphrase is used to generate a data encryption key. The key is used to securely store your credentials and prevent anyone from accessing them. + required: False + type: str + is_ubi_image: + description: + - Determines whether the collector has a Ubi image. + required: False + type: bool + name: + description: + - (Required for new resource) A unique name for your collector. + required: True + type: str is_public: description: - (Required for new resource) Determines whether the collector endpoint is accessible on a public network. If set to `true`, the collector connects to resources in your account over a public network. If set to `false`, the collector connects to resources by using a private IP that is accessible only through the IBM Cloud private network. @@ -38,21 +53,6 @@ required: False type: str default: - passphrase: - description: - - To protect the credentials that you add to the service, a passphrase is used to generate a data encryption key. The key is used to securely store your credentials and prevent anyone from accessing them. - required: False - type: str - is_ubi_image: - description: - - Determines whether the collector has a Ubi image. - required: False - type: bool - name: - description: - - (Required for new resource) A unique name for your collector. - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -99,19 +99,19 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('name', 'str'), ('is_public', 'bool'), ('managed_by', 'str'), - ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'is_public', - 'managed_by', - 'description', 'passphrase', 'is_ubi_image', 'name', + 'is_public', + 'managed_by', + 'description', ] # Params for Data source @@ -128,15 +128,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - is_public=dict( - required=False, - type='bool'), - managed_by=dict( - required=False, - type='str'), - description=dict( - required=False, - type='str'), passphrase=dict( required=False, type='str'), @@ -146,6 +137,15 @@ name=dict( required=False, type='str'), + is_public=dict( + required=False, + type='bool'), + managed_by=dict( + required=False, + type='str'), + description=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_scc_posture_credential.py b/plugins/modules/ibm_scc_posture_credential.py index 58c71fbbf..f65b93b21 100644 --- a/plugins/modules/ibm_scc_posture_credential.py +++ b/plugins/modules/ibm_scc_posture_credential.py @@ -22,23 +22,6 @@ - Terraform v0.12.20 options: - display_fields: - description: - - (Required for new resource) Details the fields on the credential. This will change as per credential type selected. - required: True - type: list - elements: dict - group: - description: - - (Required for new resource) Credential group details. - required: True - type: list - elements: dict - purpose: - description: - - (Required for new resource) Purpose for which the credential is created. - required: True - type: str enabled: description: - (Required for new resource) Credentials status enabled/disbaled. @@ -59,6 +42,23 @@ - (Required for new resource) Credentials description. required: True type: str + display_fields: + description: + - (Required for new resource) Details the fields on the credential. This will change as per credential type selected. + required: True + type: list + elements: dict + group: + description: + - (Required for new resource) Credential group details. + required: True + type: list + elements: dict + purpose: + description: + - (Required for new resource) Purpose for which the credential is created. + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -105,24 +105,24 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('display_fields', 'list'), - ('group', 'list'), - ('purpose', 'str'), ('enabled', 'bool'), ('type', 'str'), ('name', 'str'), ('description', 'str'), + ('display_fields', 'list'), + ('group', 'list'), + ('purpose', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'display_fields', - 'group', - 'purpose', 'enabled', 'type', 'name', 'description', + 'display_fields', + 'group', + 'purpose', ] # Params for Data source @@ -139,17 +139,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - display_fields=dict( - required=False, - elements='', - type='list'), - group=dict( - required=False, - elements='', - type='list'), - purpose=dict( - required=False, - type='str'), enabled=dict( required=False, type='bool'), @@ -162,6 +151,17 @@ description=dict( required=False, type='str'), + display_fields=dict( + required=False, + elements='', + type='list'), + group=dict( + required=False, + elements='', + type='list'), + purpose=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_scc_posture_scope.py b/plugins/modules/ibm_scc_posture_scope.py index 8b0defaad..a2a0a96ea 100644 --- a/plugins/modules/ibm_scc_posture_scope.py +++ b/plugins/modules/ibm_scc_posture_scope.py @@ -22,6 +22,11 @@ - Terraform v0.12.20 options: + credential_type: + description: + - (Required for new resource) The environment that the scope is targeted to. + required: True + type: str name: description: - (Required for new resource) A unique name for your scope. @@ -43,11 +48,6 @@ - (Required for new resource) The unique identifier of the credential. required: True type: str - credential_type: - description: - - (Required for new resource) The environment that the scope is targeted to. - required: True - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -94,20 +94,20 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('credential_type', 'str'), ('name', 'str'), ('description', 'str'), ('collector_ids', 'list'), ('credential_id', 'str'), - ('credential_type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'credential_type', 'name', 'description', 'collector_ids', 'credential_id', - 'credential_type', ] # Params for Data source @@ -124,6 +124,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + credential_type=dict( + required=False, + type='str'), name=dict( required=False, type='str'), @@ -137,9 +140,6 @@ credential_id=dict( required=False, type='str'), - credential_type=dict( - required=False, - type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_scc_si_note.py b/plugins/modules/ibm_scc_si_note.py index 4a3da11a8..78fec86f5 100644 --- a/plugins/modules/ibm_scc_si_note.py +++ b/plugins/modules/ibm_scc_si_note.py @@ -22,16 +22,15 @@ - Terraform v0.12.20 options: - shared: + long_description: description: - - True if this note can be shared by multiple accounts. - required: False - type: bool - default: True - finding: + - (Required for new resource) A more detailed description of your note. + required: True + type: str + reported_by: description: - - FindingType provides details about a finding note. - required: False + - (Required for new resource) The entity reporting a note. + required: True type: list elements: dict card: @@ -40,6 +39,12 @@ required: False type: list elements: dict + finding: + description: + - FindingType provides details about a finding note. + required: False + type: list + elements: dict section: description: - Card provides details about a card kind of note. @@ -51,6 +56,11 @@ - None required: False type: str + short_description: + description: + - (Required for new resource) A one sentence description of your note. + required: True + type: str kind: description: - (Required for new resource) The type of note. Use this field to filter notes and occurences by kind. - FINDING: The note and occurrence represent a finding. - KPI: The note and occurrence represent a KPI value. - CARD: The note represents a card showing findings and related metric values. - CARD_CONFIGURED: The note represents a card configured for a user account. - SECTION: The note represents a section in a dashboard. @@ -61,25 +71,21 @@ - (Required for new resource) The ID of the note. required: True type: str - kpi: + related_url: description: - - KpiType provides details about a KPI note. + - None required: False type: list elements: dict - short_description: - description: - - (Required for new resource) A one sentence description of your note. - required: True - type: str - long_description: + shared: description: - - (Required for new resource) A more detailed description of your note. - required: True - type: str - related_url: + - True if this note can be shared by multiple accounts. + required: False + type: bool + default: True + kpi: description: - - None + - KpiType provides details about a KPI note. required: False type: list elements: dict @@ -88,12 +94,6 @@ - (Required for new resource) Part of the parent. This field contains the provider ID. For example: providers/{provider_id}. required: True type: str - reported_by: - description: - - (Required for new resource) The entity reporting a note. - required: True - type: list - elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -140,29 +140,29 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('long_description', 'str'), + ('reported_by', 'list'), + ('short_description', 'str'), ('kind', 'str'), ('note_id', 'str'), - ('short_description', 'str'), - ('long_description', 'str'), ('provider_id', 'str'), - ('reported_by', 'list'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'shared', - 'finding', + 'long_description', + 'reported_by', 'card', + 'finding', 'section', 'account_id', + 'short_description', 'kind', 'note_id', - 'kpi', - 'short_description', - 'long_description', 'related_url', + 'shared', + 'kpi', 'provider_id', - 'reported_by', ] # Params for Data source @@ -184,10 +184,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - shared=dict( + long_description=dict( required=False, - type='bool'), - finding=dict( + type='str'), + reported_by=dict( required=False, elements='', type='list'), @@ -195,6 +195,10 @@ required=False, elements='', type='list'), + finding=dict( + required=False, + elements='', + type='list'), section=dict( required=False, elements='', @@ -202,33 +206,29 @@ account_id=dict( required=False, type='str'), + short_description=dict( + required=False, + type='str'), kind=dict( required=False, type='str'), note_id=dict( required=False, type='str'), - kpi=dict( + related_url=dict( required=False, elements='', type='list'), - short_description=dict( - required=False, - type='str'), - long_description=dict( + shared=dict( required=False, - type='str'), - related_url=dict( + type='bool'), + kpi=dict( required=False, elements='', type='list'), provider_id=dict( required=False, type='str'), - reported_by=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_scc_si_notes_info.py b/plugins/modules/ibm_scc_si_notes_info.py index d9936a6a4..bcafd9d9e 100644 --- a/plugins/modules/ibm_scc_si_notes_info.py +++ b/plugins/modules/ibm_scc_si_notes_info.py @@ -21,16 +21,6 @@ - Terraform v0.12.20 options: - provider_id: - description: - - Part of the parent. This field contains the provider ID. For example: providers/{provider_id}. - required: True - type: str - page_size: - description: - - Number of notes to return in the list. - required: False - type: int page_token: description: - Token to provide to skip to a particular spot in the list. @@ -41,6 +31,16 @@ - None required: False type: str + provider_id: + description: + - Part of the parent. This field contains the provider ID. For example: providers/{provider_id}. + required: True + type: str + page_size: + description: + - Number of notes to return in the list. + required: False + type: int iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -79,10 +79,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'provider_id', - 'page_size', 'page_token', 'account_id', + 'provider_id', + 'page_size', ] @@ -93,18 +93,18 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - provider_id=dict( - required=True, - type='str'), - page_size=dict( - required=False, - type='int'), page_token=dict( required=False, type='str'), account_id=dict( required=False, type='str'), + provider_id=dict( + required=True, + type='str'), + page_size=dict( + required=False, + type='int'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_scc_si_occurrence.py b/plugins/modules/ibm_scc_si_occurrence.py index 604ca9072..faca86fcd 100644 --- a/plugins/modules/ibm_scc_si_occurrence.py +++ b/plugins/modules/ibm_scc_si_occurrence.py @@ -22,36 +22,35 @@ - Terraform v0.12.20 options: + note_name: + description: + - (Required for new resource) An analysis note associated with this image, in the form "{account_id}/providers/{provider_id}/notes/{note_id}" This field can be used as a filter in list requests. + required: True + type: str occurrence_id: description: - (Required for new resource) The id of the occurrence. required: True type: str - remediation: + resource_url: description: - - A description of actions that can be taken to remedy the `Note`. + - The unique URL of the resource, image or the container, for which the `Occurrence` applies. For example, https://gcr.io/provider/image@sha256:foo. This field can be used as a filter in list requests. required: False type: str - kpi: + remediation: description: - - Kpi provides details about a KPI occurrence. + - A description of actions that can be taken to remedy the `Note`. required: False - type: list - elements: dict + type: str replace_if_exists: description: - When set to true, an existing occurrence is replaced rather than duplicated. required: False type: bool default: False - account_id: - description: - - None - required: False - type: str - note_name: + provider_id: description: - - (Required for new resource) An analysis note associated with this image, in the form "{account_id}/providers/{provider_id}/notes/{note_id}" This field can be used as a filter in list requests. + - (Required for new resource) Part of the parent. This field contains the provider ID. For example: providers/{provider_id}. required: True type: str kind: @@ -59,11 +58,6 @@ - (Required for new resource) The type of note. Use this field to filter notes and occurences by kind. - FINDING: The note and occurrence represent a finding. - KPI: The note and occurrence represent a KPI value. - CARD: The note represents a card showing findings and related metric values. - CARD_CONFIGURED: The note represents a card configured for a user account. - SECTION: The note represents a section in a dashboard. required: True type: str - resource_url: - description: - - The unique URL of the resource, image or the container, for which the `Occurrence` applies. For example, https://gcr.io/provider/image@sha256:foo. This field can be used as a filter in list requests. - required: False - type: str context: description: - None @@ -76,10 +70,16 @@ required: False type: list elements: dict - provider_id: + kpi: description: - - (Required for new resource) Part of the parent. This field contains the provider ID. For example: providers/{provider_id}. - required: True + - Kpi provides details about a KPI occurrence. + required: False + type: list + elements: dict + account_id: + description: + - None + required: False type: str id: description: @@ -127,25 +127,25 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('occurrence_id', 'str'), ('note_name', 'str'), - ('kind', 'str'), + ('occurrence_id', 'str'), ('provider_id', 'str'), + ('kind', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'note_name', 'occurrence_id', + 'resource_url', 'remediation', - 'kpi', 'replace_if_exists', - 'account_id', - 'note_name', + 'provider_id', 'kind', - 'resource_url', 'context', 'finding', - 'provider_id', + 'kpi', + 'account_id', ] # Params for Data source @@ -167,31 +167,27 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + note_name=dict( + required=False, + type='str'), occurrence_id=dict( required=False, type='str'), - remediation=dict( + resource_url=dict( required=False, type='str'), - kpi=dict( + remediation=dict( required=False, - elements='', - type='list'), + type='str'), replace_if_exists=dict( required=False, type='bool'), - account_id=dict( - required=False, - type='str'), - note_name=dict( + provider_id=dict( required=False, type='str'), kind=dict( required=False, type='str'), - resource_url=dict( - required=False, - type='str'), context=dict( required=False, elements='', @@ -200,7 +196,11 @@ required=False, elements='', type='list'), - provider_id=dict( + kpi=dict( + required=False, + elements='', + type='list'), + account_id=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_scc_si_occurrences_info.py b/plugins/modules/ibm_scc_si_occurrences_info.py index 024385354..574fb574b 100644 --- a/plugins/modules/ibm_scc_si_occurrences_info.py +++ b/plugins/modules/ibm_scc_si_occurrences_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + page_token: + description: + - Token to provide to skip to a particular spot in the list. + required: False + type: str account_id: description: - None @@ -36,11 +41,6 @@ - Number of notes to return in the list. required: False type: int - page_token: - description: - - Token to provide to skip to a particular spot in the list. - required: False - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -79,10 +79,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'page_token', 'account_id', 'provider_id', 'page_size', - 'page_token', ] @@ -93,6 +93,9 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + page_token=dict( + required=False, + type='str'), account_id=dict( required=False, type='str'), @@ -102,9 +105,6 @@ page_size=dict( required=False, type='int'), - page_token=dict( - required=False, - type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_scc_si_providers_info.py b/plugins/modules/ibm_scc_si_providers_info.py index 8662078f0..a155433f3 100644 --- a/plugins/modules/ibm_scc_si_providers_info.py +++ b/plugins/modules/ibm_scc_si_providers_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + account_id: + description: + - None + required: False + type: str limit: description: - The number of elements returned in the current instance. The default is 200. @@ -31,11 +36,6 @@ - The offset is the index of the item from which you want to start returning data from. The default is 0. required: False type: int - account_id: - description: - - None - required: False - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -73,9 +73,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'account_id', 'limit', 'skip', - 'account_id', ] @@ -86,15 +86,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + account_id=dict( + required=False, + type='str'), limit=dict( required=False, type='int'), skip=dict( required=False, type='int'), - account_id=dict( - required=False, - type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_schematics_action.py b/plugins/modules/ibm_schematics_action.py index a69ee6a93..997d8d3ef 100644 --- a/plugins/modules/ibm_schematics_action.py +++ b/plugins/modules/ibm_schematics_action.py @@ -22,31 +22,48 @@ - Terraform v0.12.20 options: - sys_lock: + source_type: description: - - System lock status. + - Type of source for the Template. + required: False + type: str + credentials: + description: + - credentials of the Action. required: False type: list elements: dict - name: + action_inputs: description: - - (Required for new resource) The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. **Example** you can use the name to stop action. - required: True + - Input variables for the Action. + required: False + type: list + elements: dict + user_state: + description: + - User defined status of the Schematics object. + required: False + type: list + elements: dict + command_parameter: + description: + - Schematics job command parameter (playbook-name). + required: False type: str - settings: + bastion_credential: description: - - Environment variables for the Action. + - User editable variable data & system generated reference to value. required: False type: list elements: dict - description: + targets_ini: description: - - Action description. + - Inventory of host and host group for the playbook in `INI` file format. For example, `"targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5"`. For more information, about an inventory host group syntax, see [Inventory host groups](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-inventory-host-grps). required: False type: str - location: + description: description: - - List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. + - Action description. required: False type: str resource_group: @@ -54,49 +71,40 @@ - Resource-group name for an action. By default, action is created in default resource group. required: False type: str - tags: - description: - - Action tags. - required: False - type: list - elements: str bastion: description: - Describes a bastion resource. required: False type: list elements: dict - targets_ini: - description: - - Inventory of host and host group for the playbook in `INI` file format. For example, `"targets_ini": "[webserverhost] 172.22.192.6 [dbhost] 172.22.192.5"`. For more information, about an inventory host group syntax, see [Inventory host groups](https://cloud.ibm.com/docs/schematics?topic=schematics-schematics-cli-reference#schematics-inventory-host-grps). - required: False - type: str - x_github_token: + settings: description: - - The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform template. + - Environment variables for the Action. required: False - type: str - action_outputs: + type: list + elements: dict + sys_lock: description: - - Output variables for the Action. + - System lock status. required: False type: list elements: dict - source_readme_url: + location: description: - - URL of the `README` file, for the source URL. + - List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. required: False type: str - source_type: + x_github_token: description: - - Type of source for the Template. + - The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform template. required: False type: str - command_parameter: + tags: description: - - Schematics job command parameter (playbook-name). + - Action tags. required: False - type: str + type: list + elements: str source: description: - Source of templates, playbooks, or controls. @@ -108,30 +116,22 @@ - Target inventory record ID, used by the action or ansible playbook. required: False type: str - action_inputs: - description: - - Input variables for the Action. - required: False - type: list - elements: dict - user_state: + action_outputs: description: - - User defined status of the Schematics object. + - Output variables for the Action. required: False type: list elements: dict - credentials: + name: description: - - credentials of the Action. - required: False - type: list - elements: dict - bastion_credential: + - (Required for new resource) The unique name of your action. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. **Example** you can use the name to stop action. + required: True + type: str + source_readme_url: description: - - User editable variable data & system generated reference to value. + - URL of the `README` file, for the source URL. required: False - type: list - elements: dict + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -183,26 +183,26 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'sys_lock', - 'name', - 'settings', + 'source_type', + 'credentials', + 'action_inputs', + 'user_state', + 'command_parameter', + 'bastion_credential', + 'targets_ini', 'description', - 'location', 'resource_group', - 'tags', 'bastion', - 'targets_ini', + 'settings', + 'sys_lock', + 'location', 'x_github_token', - 'action_outputs', - 'source_readme_url', - 'source_type', - 'command_parameter', + 'tags', 'source', 'inventory', - 'action_inputs', - 'user_state', - 'credentials', - 'bastion_credential', + 'action_outputs', + 'name', + 'source_readme_url', ] # Params for Data source @@ -221,53 +221,59 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - sys_lock=dict( + source_type=dict( + required=False, + type='str'), + credentials=dict( required=False, elements='', type='list'), - name=dict( + action_inputs=dict( + required=False, + elements='', + type='list'), + user_state=dict( + required=False, + elements='', + type='list'), + command_parameter=dict( required=False, type='str'), - settings=dict( + bastion_credential=dict( required=False, elements='', type='list'), - description=dict( + targets_ini=dict( required=False, type='str'), - location=dict( + description=dict( required=False, type='str'), resource_group=dict( required=False, type='str'), - tags=dict( + bastion=dict( required=False, elements='', type='list'), - bastion=dict( + settings=dict( required=False, elements='', type='list'), - targets_ini=dict( - required=False, - type='str'), - x_github_token=dict( - required=False, - type='str'), - action_outputs=dict( + sys_lock=dict( required=False, elements='', type='list'), - source_readme_url=dict( + location=dict( required=False, type='str'), - source_type=dict( + x_github_token=dict( required=False, type='str'), - command_parameter=dict( + tags=dict( required=False, - type='str'), + elements='', + type='list'), source=dict( required=False, elements='', @@ -275,22 +281,16 @@ inventory=dict( required=False, type='str'), - action_inputs=dict( - required=False, - elements='', - type='list'), - user_state=dict( + action_outputs=dict( required=False, elements='', type='list'), - credentials=dict( + name=dict( required=False, - elements='', - type='list'), - bastion_credential=dict( + type='str'), + source_readme_url=dict( required=False, - elements='', - type='list'), + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_schematics_inventory.py b/plugins/modules/ibm_schematics_inventory.py index 1a33462f0..f3e47c442 100644 --- a/plugins/modules/ibm_schematics_inventory.py +++ b/plugins/modules/ibm_schematics_inventory.py @@ -22,24 +22,24 @@ - Terraform v0.12.20 options: - location: + name: description: - - List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. + - The unique name of your Inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. required: False type: str - resource_group: + description: description: - - Resource-group name for the Inventory definition. By default, Inventory definition will be created in Default Resource Group. + - The description of your Inventory definition. The description can be up to 2048 characters long in size. required: False type: str - name: + resource_group: description: - - The unique name of your Inventory definition. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. + - Resource-group name for the Inventory definition. By default, Inventory definition will be created in Default Resource Group. required: False type: str - description: + location: description: - - The description of your Inventory definition. The description can be up to 2048 characters long in size. + - List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. required: False type: str inventories_ini: @@ -103,10 +103,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'location', - 'resource_group', 'name', 'description', + 'resource_group', + 'location', 'inventories_ini', 'resource_queries', ] @@ -127,16 +127,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - location=dict( + name=dict( required=False, type='str'), - resource_group=dict( + description=dict( required=False, type='str'), - name=dict( + resource_group=dict( required=False, type='str'), - description=dict( + location=dict( required=False, type='str'), inventories_ini=dict( diff --git a/plugins/modules/ibm_schematics_job.py b/plugins/modules/ibm_schematics_job.py index e297ae625..f94b58f56 100644 --- a/plugins/modules/ibm_schematics_job.py +++ b/plugins/modules/ibm_schematics_job.py @@ -22,19 +22,20 @@ - Terraform v0.12.20 options: - command_object_id: + location: description: - - (Required for new resource) Job command object id (workspace-id, action-id). - required: True + - List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. + required: False type: str - command_name: + data: description: - - (Required for new resource) Schematics job command name. - required: True - type: str - job_inputs: + - Job data. + required: False + type: list + elements: dict + bastion: description: - - Job inputs used by Action or Workspace. + - Describes a bastion resource. required: False type: list elements: dict @@ -49,43 +50,42 @@ - (Required for new resource) Name of the Schematics automation resource. required: True type: str - job_env_settings: + command_object_id: description: - - Environment variables used by the Job while performing Action or Workspace. - required: False - type: list - elements: dict + - (Required for new resource) Job command object id (workspace-id, action-id). + required: True + type: str + command_name: + description: + - (Required for new resource) Schematics job command name. + required: True + type: str command_parameter: description: - Schematics job command parameter (playbook-name). required: False type: str - tags: + command_options: description: - - User defined tags, while running the job. + - Command line options for the command. required: False type: list elements: str - bastion: - description: - - Describes a bastion resource. - required: False - type: list - elements: dict - command_options: + tags: description: - - Command line options for the command. + - User defined tags, while running the job. required: False type: list elements: str - location: + job_inputs: description: - - List of locations supported by IBM Cloud Schematics service. While creating your workspace or action, choose the right region, since it cannot be changed. Note, this does not limit the location of the IBM Cloud resources, provisioned using Schematics. + - Job inputs used by Action or Workspace. required: False - type: str - data: + type: list + elements: dict + job_env_settings: description: - - Job data. + - Environment variables used by the Job while performing Action or Workspace. required: False type: list elements: dict @@ -135,25 +135,25 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ + ('command_object', 'str'), ('command_object_id', 'str'), ('command_name', 'str'), - ('command_object', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'command_object_id', - 'command_name', - 'job_inputs', + 'location', + 'data', + 'bastion', 'log_summary', 'command_object', - 'job_env_settings', + 'command_object_id', + 'command_name', 'command_parameter', - 'tags', - 'bastion', 'command_options', - 'location', - 'data', + 'tags', + 'job_inputs', + 'job_env_settings', ] # Params for Data source @@ -172,13 +172,14 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - command_object_id=dict( + location=dict( required=False, type='str'), - command_name=dict( + data=dict( required=False, - type='str'), - job_inputs=dict( + elements='', + type='list'), + bastion=dict( required=False, elements='', type='list'), @@ -189,29 +190,28 @@ command_object=dict( required=False, type='str'), - job_env_settings=dict( + command_object_id=dict( required=False, - elements='', - type='list'), + type='str'), + command_name=dict( + required=False, + type='str'), command_parameter=dict( required=False, type='str'), - tags=dict( + command_options=dict( required=False, elements='', type='list'), - bastion=dict( + tags=dict( required=False, elements='', type='list'), - command_options=dict( + job_inputs=dict( required=False, elements='', type='list'), - location=dict( - required=False, - type='str'), - data=dict( + job_env_settings=dict( required=False, elements='', type='list'), diff --git a/plugins/modules/ibm_schematics_output_info.py b/plugins/modules/ibm_schematics_output_info.py index 55e05ae7e..e5367a387 100644 --- a/plugins/modules/ibm_schematics_output_info.py +++ b/plugins/modules/ibm_schematics_output_info.py @@ -21,6 +21,11 @@ - Terraform v0.12.20 options: + output_json: + description: + - The json output in string + required: False + type: str workspace_id: description: - The ID of the workspace for which you want to retrieve output values. To find the workspace ID, use the `GET /workspaces` API. @@ -31,11 +36,6 @@ - The id of template required: True type: str - output_json: - description: - - The json output in string - required: False - type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -75,9 +75,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'output_json', 'workspace_id', 'template_id', - 'output_json', ] @@ -88,15 +88,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + output_json=dict( + required=False, + type='str'), workspace_id=dict( required=True, type='str'), template_id=dict( required=True, type='str'), - output_json=dict( - required=False, - type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_schematics_resource_query.py b/plugins/modules/ibm_schematics_resource_query.py index 27e14cc9b..96b477277 100644 --- a/plugins/modules/ibm_schematics_resource_query.py +++ b/plugins/modules/ibm_schematics_resource_query.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - type: - description: - - Resource type (cluster, vsi, icd, vpc). - required: False - type: str name: description: - Resource query name. @@ -38,6 +33,11 @@ required: False type: list elements: dict + type: + description: + - Resource type (cluster, vsi, icd, vpc). + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -88,9 +88,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'type', 'name', 'queries', + 'type', ] # Params for Data source @@ -109,9 +109,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - type=dict( - required=False, - type='str'), name=dict( required=False, type='str'), @@ -119,6 +116,9 @@ required=False, elements='', type='list'), + type=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_schematics_workspace.py b/plugins/modules/ibm_schematics_workspace.py index f7e6318e5..ee534fda7 100644 --- a/plugins/modules/ibm_schematics_workspace.py +++ b/plugins/modules/ibm_schematics_workspace.py @@ -22,30 +22,19 @@ - Terraform v0.12.20 options: - catalog_ref: - description: - - Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. - required: False - type: list - elements: dict - template_uninstall_script_name: - description: - - Uninstall script name. - required: False - type: str - frozen_by: + locked: description: - - The user ID that froze the workspace. + - If set to true, the workspace is locked and disabled for changes. required: False - type: str - template_init_state_file: + type: bool + locked_by: description: - - The content of an existing Terraform statefile that you want to import in to your workspace. To get the content of a Terraform statefile for a specific Terraform template in an existing workspace, run `ibmcloud terraform state pull --id --template `. + - The user ID that initiated a resource-related action, such as applying or destroying resources, that locked the workspace. required: False type: str - template_ref: + x_github_token: description: - - Workspace template ref. + - The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform template. required: False type: str template_git_repo_url: @@ -53,99 +42,115 @@ - The repository URL. required: False type: str - applied_shareddata_ids: + shared_data: description: - - List of applied shared dataset ID. + - Information about the Target used by the templates originating from the IBM Cloud catalog offerings. This information is not relevant for workspace created using your own Terraform template. required: False type: list - elements: str - template_git_has_uploadedgitrepotar: + elements: dict + template_ref: description: - - Has uploaded git repo tar + - Workspace template ref. required: False - type: bool - x_github_token: + type: str + template_git_branch: description: - - The personal access token to authenticate with your private GitHub or GitLab repository and access your Terraform template. + - The repository branch. required: False type: str - frozen_at: + template_git_release: description: - - The timestamp when the workspace was frozen. + - The repository release. required: False type: str - locked: + frozen_by: description: - - If set to true, the workspace is locked and disabled for changes. + - The user ID that froze the workspace. required: False - type: bool - locked_by: + type: str + description: description: - - The user ID that initiated a resource-related action, such as applying or destroying resources, that locked the workspace. + - The description of the workspace. required: False type: str - template_env_settings: + template_values_metadata: description: - - A list of environment variables that you want to apply during the execution of a bash script or Terraform job. This field must be provided as a list of key-value pairs, for example, **TF_LOG=debug**. Each entry will be a map with one entry where `key is the environment variable name and value is value`. You can define environment variables for IBM Cloud catalog offerings that are provisioned by using a bash script. See [example to use special environment variable](https://cloud.ibm.com/docs/schematics?topic=schematics-set-parallelism#parallelism-example) that are supported by Schematics. + - List of values metadata. required: False type: list elements: dict - template_git_branch: + template_values: description: - - The repository branch. + - A list of variable values that you want to apply during the Helm chart installation. The list must be provided in JSON format, such as `"autoscaling: enabled: true minReplicas: 2"`. The values that you define here override the default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by using the Terraform Helm provider. required: False type: str - frozen: + tags: description: - - If set to true, the workspace is frozen and changes to the workspace are disabled. + - A list of tags that are associated with the workspace. required: False - type: bool - template_values_metadata: + type: list + elements: str + template_env_settings: description: - - List of values metadata. + - A list of environment variables that you want to apply during the execution of a bash script or Terraform job. This field must be provided as a list of key-value pairs, for example, **TF_LOG=debug**. Each entry will be a map with one entry where `key is the environment variable name and value is value`. You can define environment variables for IBM Cloud catalog offerings that are provisioned by using a bash script. See [example to use special environment variable](https://cloud.ibm.com/docs/schematics?topic=schematics-set-parallelism#parallelism-example) that are supported by Schematics. required: False type: list elements: dict - template_inputs: + template_init_state_file: description: - - VariablesRequest -. + - The content of an existing Terraform statefile that you want to import in to your workspace. To get the content of a Terraform statefile for a specific Terraform template in an existing workspace, run `ibmcloud terraform state pull --id --template `. required: False - type: list - elements: dict - template_git_release: + type: str + template_type: description: - - The repository release. + - (Required for new resource) The Terraform version that you want to use to run your Terraform code. Enter `terraform_v0.12` to use Terraform version 0.12, and `terraform_v0.11` to use Terraform version 0.11. The Terraform config files are run with Terraform version 0.11. This is a required variable. Make sure that your Terraform config files are compatible with the Terraform version that you select. + required: True + type: str + name: + description: + - (Required for new resource) The name of your workspace. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. When you create a workspace for your own Terraform template, consider including the microservice component that you set up with your Terraform template and the IBM Cloud environment where you want to deploy your resources in your name. + required: True + type: str + template_uninstall_script_name: + description: + - Uninstall script name. required: False type: str - resource_group: + frozen_at: description: - - The ID of the resource group where you want to provision the workspace. + - The timestamp when the workspace was frozen. required: False type: str + applied_shareddata_ids: + description: + - List of applied shared dataset ID. + required: False + type: list + elements: str template_git_folder: description: - The subfolder in your GitHub or GitLab repository where your Terraform template is stored. required: False type: str - template_type: - description: - - (Required for new resource) The Terraform version that you want to use to run your Terraform code. Enter `terraform_v0.12` to use Terraform version 0.12, and `terraform_v0.11` to use Terraform version 0.11. The Terraform config files are run with Terraform version 0.11. This is a required variable. Make sure that your Terraform config files are compatible with the Terraform version that you select. - required: True - type: str - shared_data: + template_inputs: description: - - Information about the Target used by the templates originating from the IBM Cloud catalog offerings. This information is not relevant for workspace created using your own Terraform template. + - VariablesRequest -. required: False type: list elements: dict - template_values: + template_git_has_uploadedgitrepotar: description: - - A list of variable values that you want to apply during the Helm chart installation. The list must be provided in JSON format, such as `"autoscaling: enabled: true minReplicas: 2"`. The values that you define here override the default Helm chart values. This field is supported only for IBM Cloud catalog offerings that are provisioned by using the Terraform Helm provider. + - Has uploaded git repo tar required: False - type: str - description: + type: bool + frozen: description: - - The description of the workspace. + - If set to true, the workspace is frozen and changes to the workspace are disabled. + required: False + type: bool + locked_time: + description: + - The timestamp when the workspace was locked. required: False type: str location: @@ -153,17 +158,11 @@ - The location where you want to create your Schematics workspace and run the Schematics jobs. The location that you enter must match the API endpoint that you use. For example, if you use the Frankfurt API endpoint, you must specify `eu-de` as your location. If you use an API endpoint for a geography and you do not specify a location, Schematics determines the location based on availability. required: False type: str - name: - description: - - (Required for new resource) The name of your workspace. The name can be up to 128 characters long and can include alphanumeric characters, spaces, dashes, and underscores. When you create a workspace for your own Terraform template, consider including the microservice component that you set up with your Terraform template and the IBM Cloud environment where you want to deploy your resources in your name. - required: True - type: str - tags: + resource_group: description: - - A list of tags that are associated with the workspace. + - The ID of the resource group where you want to provision the workspace. required: False - type: list - elements: str + type: str template_git_repo_sha_value: description: - The repository SHA value. @@ -174,11 +173,12 @@ - The source URL. required: False type: str - locked_time: + catalog_ref: description: - - The timestamp when the workspace was locked. + - Information about the software template that you chose from the IBM Cloud catalog. This information is returned for IBM Cloud catalog offerings only. required: False - type: str + type: list + elements: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -231,36 +231,36 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'catalog_ref', - 'template_uninstall_script_name', - 'frozen_by', - 'template_init_state_file', - 'template_ref', - 'template_git_repo_url', - 'applied_shareddata_ids', - 'template_git_has_uploadedgitrepotar', - 'x_github_token', - 'frozen_at', 'locked', 'locked_by', - 'template_env_settings', + 'x_github_token', + 'template_git_repo_url', + 'shared_data', + 'template_ref', 'template_git_branch', - 'frozen', - 'template_values_metadata', - 'template_inputs', 'template_git_release', - 'resource_group', - 'template_git_folder', - 'template_type', - 'shared_data', - 'template_values', + 'frozen_by', 'description', - 'location', - 'name', + 'template_values_metadata', + 'template_values', 'tags', + 'template_env_settings', + 'template_init_state_file', + 'template_type', + 'name', + 'template_uninstall_script_name', + 'frozen_at', + 'applied_shareddata_ids', + 'template_git_folder', + 'template_inputs', + 'template_git_has_uploadedgitrepotar', + 'frozen', + 'locked_time', + 'location', + 'resource_group', 'template_git_repo_sha_value', 'template_git_url', - 'locked_time', + 'catalog_ref', ] # Params for Data source @@ -270,8 +270,8 @@ TL_ALL_PARAMETERS_DS = [ 'workspace_id', - 'template_values_metadata', 'template_git_has_uploadedgitrepotar', + 'template_values_metadata', ] TL_CONFLICTS_MAP = { @@ -281,103 +281,103 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - catalog_ref=dict( - required=False, - elements='', - type='list'), - template_uninstall_script_name=dict( - required=False, - type='str'), - frozen_by=dict( + locked=dict( required=False, - type='str'), - template_init_state_file=dict( + type='bool'), + locked_by=dict( required=False, type='str'), - template_ref=dict( + x_github_token=dict( required=False, type='str'), template_git_repo_url=dict( required=False, type='str'), - applied_shareddata_ids=dict( + shared_data=dict( required=False, elements='', type='list'), - template_git_has_uploadedgitrepotar=dict( + template_ref=dict( required=False, - type='bool'), - x_github_token=dict( + type='str'), + template_git_branch=dict( required=False, type='str'), - frozen_at=dict( + template_git_release=dict( required=False, type='str'), - locked=dict( + frozen_by=dict( required=False, - type='bool'), - locked_by=dict( + type='str'), + description=dict( required=False, type='str'), - template_env_settings=dict( + template_values_metadata=dict( required=False, elements='', type='list'), - template_git_branch=dict( + template_values=dict( required=False, type='str'), - frozen=dict( - required=False, - type='bool'), - template_values_metadata=dict( + tags=dict( required=False, elements='', type='list'), - template_inputs=dict( + template_env_settings=dict( required=False, elements='', type='list'), - template_git_release=dict( + template_init_state_file=dict( required=False, type='str'), - resource_group=dict( + template_type=dict( required=False, type='str'), - template_git_folder=dict( + name=dict( required=False, type='str'), - template_type=dict( + template_uninstall_script_name=dict( required=False, type='str'), - shared_data=dict( + frozen_at=dict( + required=False, + type='str'), + applied_shareddata_ids=dict( required=False, elements='', type='list'), - template_values=dict( + template_git_folder=dict( required=False, type='str'), - description=dict( + template_inputs=dict( + required=False, + elements='', + type='list'), + template_git_has_uploadedgitrepotar=dict( + required=False, + type='bool'), + frozen=dict( + required=False, + type='bool'), + locked_time=dict( required=False, type='str'), location=dict( required=False, type='str'), - name=dict( + resource_group=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), template_git_repo_sha_value=dict( required=False, type='str'), template_git_url=dict( required=False, type='str'), - locked_time=dict( + catalog_ref=dict( required=False, - type='str'), + elements='', + type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_schematics_workspace_info.py b/plugins/modules/ibm_schematics_workspace_info.py index 9f7183aee..1e5bd9215 100644 --- a/plugins/modules/ibm_schematics_workspace_info.py +++ b/plugins/modules/ibm_schematics_workspace_info.py @@ -26,17 +26,17 @@ - The ID of the workspace. To find the workspace ID, use the `GET /v1/workspaces` API. required: True type: str + template_git_has_uploadedgitrepotar: + description: + - Has uploaded Git repository tar. + required: False + type: bool template_values_metadata: description: - A list of input variables that are associated with the workspace. required: False type: list elements: dict - template_git_has_uploadedgitrepotar: - description: - - Has uploaded Git repository tar. - required: False - type: bool iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -76,8 +76,8 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ 'workspace_id', - 'template_values_metadata', 'template_git_has_uploadedgitrepotar', + 'template_values_metadata', ] @@ -91,13 +91,13 @@ workspace_id=dict( required=True, type='str'), + template_git_has_uploadedgitrepotar=dict( + required=False, + type='bool'), template_values_metadata=dict( required=False, elements='', type='list'), - template_git_has_uploadedgitrepotar=dict( - required=False, - type='bool'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_secrets_manager_secret_info.py b/plugins/modules/ibm_secrets_manager_secret_info.py index 4d9f6c81d..09ee69611 100644 --- a/plugins/modules/ibm_secrets_manager_secret_info.py +++ b/plugins/modules/ibm_secrets_manager_secret_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - instance_id: + secret_id: description: - - Secrets Manager instance GUID + - The v4 UUID that uniquely identifies the secret. required: True type: str - secret_id: + secret_type: description: - - The v4 UUID that uniquely identifies the secret. + - The secret type. Supported options include: arbitrary, iam_credentials, username_password. required: True type: str endpoint_type: @@ -37,9 +37,9 @@ required: False type: str default: public - secret_type: + instance_id: description: - - The secret type. Supported options include: arbitrary, iam_credentials, username_password. + - Secrets Manager instance GUID required: True type: str iaas_classic_username: @@ -75,17 +75,17 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('instance_id', 'str'), ('secret_id', 'str'), ('secret_type', 'str'), + ('instance_id', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'instance_id', 'secret_id', - 'endpoint_type', 'secret_type', + 'endpoint_type', + 'instance_id', ] @@ -96,16 +96,16 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - instance_id=dict( + secret_id=dict( required=True, type='str'), - secret_id=dict( + secret_type=dict( required=True, type='str'), endpoint_type=dict( required=False, type='str'), - secret_type=dict( + instance_id=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_secrets_manager_secrets_info.py b/plugins/modules/ibm_secrets_manager_secrets_info.py index 648bc92b0..aa7d244ea 100644 --- a/plugins/modules/ibm_secrets_manager_secrets_info.py +++ b/plugins/modules/ibm_secrets_manager_secrets_info.py @@ -21,12 +21,6 @@ - Terraform v0.12.20 options: - endpoint_type: - description: - - Endpoint Type. 'public' or 'private' - required: False - type: str - default: public instance_id: description: - Secrets Manager instance GUID @@ -37,6 +31,12 @@ - The secret type. Supported options include: arbitrary, iam_credentials, username_password. required: False type: str + endpoint_type: + description: + - Endpoint Type. 'public' or 'private' + required: False + type: str + default: public iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -75,9 +75,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'endpoint_type', 'instance_id', 'secret_type', + 'endpoint_type', ] @@ -88,15 +88,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - endpoint_type=dict( - required=False, - type='str'), instance_id=dict( required=True, type='str'), secret_type=dict( required=False, type='str'), + endpoint_type=dict( + required=False, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_security_group.py b/plugins/modules/ibm_security_group.py index 67d16157c..ba864824a 100644 --- a/plugins/modules/ibm_security_group.py +++ b/plugins/modules/ibm_security_group.py @@ -93,9 +93,9 @@ ] TL_ALL_PARAMETERS_DS = [ - 'description', 'most_recent', 'name', + 'description', ] TL_CONFLICTS_MAP = { diff --git a/plugins/modules/ibm_security_group_info.py b/plugins/modules/ibm_security_group_info.py index 5760d633d..75cfc92b4 100644 --- a/plugins/modules/ibm_security_group_info.py +++ b/plugins/modules/ibm_security_group_info.py @@ -21,11 +21,6 @@ - Terraform v0.12.20 options: - description: - description: - - The description of the security group - required: False - type: str most_recent: description: - If true and multiple entries are found, the most recently created group is used. If false, an error is returned @@ -37,6 +32,11 @@ - The name of the security group required: True type: str + description: + description: + - The description of the security group + required: False + type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -75,9 +75,9 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'description', 'most_recent', 'name', + 'description', ] @@ -88,15 +88,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - description=dict( - required=False, - type='str'), most_recent=dict( required=False, type='bool'), name=dict( required=True, type='str'), + description=dict( + required=False, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_security_group_rule.py b/plugins/modules/ibm_security_group_rule.py index 423cb69f6..930e6efd4 100644 --- a/plugins/modules/ibm_security_group_rule.py +++ b/plugins/modules/ibm_security_group_rule.py @@ -22,11 +22,6 @@ - Terraform v0.12.20 options: - direction: - description: - - (Required for new resource) Direction of rule: ingress or egress - required: True - type: str ether_type: description: - IP version IPv4 or IPv6 @@ -63,6 +58,11 @@ - (Required for new resource) Security group ID required: True type: int + direction: + description: + - (Required for new resource) Direction of rule: ingress or egress + required: True + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -109,13 +109,12 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('direction', 'str'), ('security_group_id', 'int'), + ('direction', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'direction', 'ether_type', 'port_range_min', 'port_range_max', @@ -123,6 +122,7 @@ 'remote_ip', 'protocol', 'security_group_id', + 'direction', ] # Params for Data source @@ -141,9 +141,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - direction=dict( - required=False, - type='str'), ether_type=dict( required=False, type='str'), @@ -165,6 +162,9 @@ security_group_id=dict( required=False, type='int'), + direction=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_service_instance.py b/plugins/modules/ibm_service_instance.py index e5c649ad2..dad3034b8 100644 --- a/plugins/modules/ibm_service_instance.py +++ b/plugins/modules/ibm_service_instance.py @@ -22,17 +22,6 @@ - Terraform v0.12.20 options: - parameters: - description: - - Arbitrary parameters to pass along to the service broker. Must be a JSON object - required: False - type: dict - tags: - description: - - None - required: False - type: list - elements: str wait_time_minutes: description: - Define timeout to wait for the service instances to succeeded/deleted etc. @@ -44,21 +33,32 @@ - (Required for new resource) A name for the service instance required: True type: str - space_guid: - description: - - (Required for new resource) The guid of the space in which the instance will be created - required: True - type: str service: description: - (Required for new resource) The name of the service offering like speech_to_text, text_to_speech etc required: True type: str + tags: + description: + - None + required: False + type: list + elements: str plan: description: - (Required for new resource) The plan type of the service required: True type: str + space_guid: + description: + - (Required for new resource) The guid of the space in which the instance will be created + required: True + type: str + parameters: + description: + - Arbitrary parameters to pass along to the service broker. Must be a JSON object + required: False + type: dict id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -106,31 +106,31 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('name', 'str'), - ('space_guid', 'str'), ('service', 'str'), ('plan', 'str'), + ('space_guid', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'parameters', - 'tags', 'wait_time_minutes', 'name', - 'space_guid', 'service', + 'tags', 'plan', + 'space_guid', + 'parameters', ] # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('name', 'str'), ('space_guid', 'str'), + ('name', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'name', 'space_guid', + 'name', ] TL_CONFLICTS_MAP = { @@ -140,28 +140,28 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - parameters=dict( - required=False, - type='dict'), - tags=dict( - required=False, - elements='', - type='list'), wait_time_minutes=dict( required=False, type='int'), name=dict( required=False, type='str'), - space_guid=dict( - required=False, - type='str'), service=dict( required=False, type='str'), + tags=dict( + required=False, + elements='', + type='list'), plan=dict( required=False, type='str'), + space_guid=dict( + required=False, + type='str'), + parameters=dict( + required=False, + type='dict'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_service_instance_info.py b/plugins/modules/ibm_service_instance_info.py index cdf2db934..d5c18e52a 100644 --- a/plugins/modules/ibm_service_instance_info.py +++ b/plugins/modules/ibm_service_instance_info.py @@ -21,14 +21,14 @@ - Terraform v0.12.20 options: - name: + space_guid: description: - - Service instance name for example, speech_to_text + - The guid of the space in which the instance is present required: True type: str - space_guid: + name: description: - - The guid of the space in which the instance is present + - Service instance name for example, speech_to_text required: True type: str iaas_classic_username: @@ -64,14 +64,14 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('space_guid', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'space_guid', + 'name', ] @@ -82,10 +82,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( + space_guid=dict( required=True, type='str'), - space_guid=dict( + name=dict( required=True, type='str'), iaas_classic_username=dict( diff --git a/plugins/modules/ibm_service_key.py b/plugins/modules/ibm_service_key.py index a0f274474..7f94139f0 100644 --- a/plugins/modules/ibm_service_key.py +++ b/plugins/modules/ibm_service_key.py @@ -103,15 +103,15 @@ # Params for Data source TL_REQUIRED_PARAMETERS_DS = [ - ('name', 'str'), ('service_instance_name', 'str'), ('space_guid', 'str'), + ('name', 'str'), ] TL_ALL_PARAMETERS_DS = [ - 'name', 'service_instance_name', 'space_guid', + 'name', ] TL_CONFLICTS_MAP = { diff --git a/plugins/modules/ibm_service_key_info.py b/plugins/modules/ibm_service_key_info.py index e26362f05..a559a5f4a 100644 --- a/plugins/modules/ibm_service_key_info.py +++ b/plugins/modules/ibm_service_key_info.py @@ -21,11 +21,6 @@ - Terraform v0.12.20 options: - name: - description: - - The name of the service key - required: True - type: str service_instance_name: description: - Service instance name for example, speech_to_text @@ -36,6 +31,11 @@ - The guid of the space in which the service instance is present required: True type: str + name: + description: + - The name of the service key + required: True + type: str iaas_classic_username: description: - (Required when generation = 1) The IBM Cloud Classic @@ -69,16 +69,16 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('name', 'str'), ('service_instance_name', 'str'), ('space_guid', 'str'), + ('name', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'name', 'service_instance_name', 'space_guid', + 'name', ] @@ -89,15 +89,15 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - name=dict( - required=True, - type='str'), service_instance_name=dict( required=True, type='str'), space_guid=dict( required=True, type='str'), + name=dict( + required=True, + type='str'), iaas_classic_username=dict( type='str', no_log=True, diff --git a/plugins/modules/ibm_space.py b/plugins/modules/ibm_space.py index 6ee68c5d8..51874ecc5 100644 --- a/plugins/modules/ibm_space.py +++ b/plugins/modules/ibm_space.py @@ -22,23 +22,6 @@ - Terraform v0.12.20 options: - managers: - description: - - The IBMID of the users who will have manager role in this space, ex - user@example.com - required: False - type: list - elements: str - developers: - description: - - The IBMID of the users who will have developer role in this space, ex - user@example.com - required: False - type: list - elements: str - space_quota: - description: - - The name of the Space Quota Definition - required: False - type: str tags: description: - None @@ -61,6 +44,23 @@ required: False type: list elements: str + managers: + description: + - The IBMID of the users who will have manager role in this space, ex - user@example.com + required: False + type: list + elements: str + developers: + description: + - The IBMID of the users who will have developer role in this space, ex - user@example.com + required: False + type: list + elements: str + space_quota: + description: + - The name of the Space Quota Definition + required: False + type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -113,13 +113,13 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'managers', - 'developers', - 'space_quota', 'tags', 'name', 'org', 'auditors', + 'managers', + 'developers', + 'space_quota', ] # Params for Data source @@ -140,17 +140,6 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - managers=dict( - required=False, - elements='', - type='list'), - developers=dict( - required=False, - elements='', - type='list'), - space_quota=dict( - required=False, - type='str'), tags=dict( required=False, elements='', @@ -165,6 +154,17 @@ required=False, elements='', type='list'), + managers=dict( + required=False, + elements='', + type='list'), + developers=dict( + required=False, + elements='', + type='list'), + space_quota=dict( + required=False, + type='str'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_ssl_certificate.py b/plugins/modules/ibm_ssl_certificate.py index c06f804b6..8c0e092fc 100644 --- a/plugins/modules/ibm_ssl_certificate.py +++ b/plugins/modules/ibm_ssl_certificate.py @@ -22,71 +22,65 @@ - Terraform v0.12.20 options: - validity_months: - description: - - (Required for new resource) vslidity of the ssl certificate in month - required: True - type: int - certificate_signing_request: + billing_contact_same_as_technical_flag: description: - - (Required for new resource) certificate signing request info - required: True - type: str + - billing contact + required: False + type: bool + default: False administrative_contact: description: - None required: False type: list elements: dict - billing_contact: + organization_information: description: - - None - required: False + - (Required for new resource) Organization information + required: True type: list elements: dict - order_approver_email_address: + server_count: description: - - (Required for new resource) Email address of the approver + - (Required for new resource) Server count required: True - type: str + type: int technical_contact_same_as_org_address_flag: description: - Technical contact same as org address flag required: False type: bool default: False + renewal_flag: + description: + - Renewal flag + required: False + type: bool + default: True + order_approver_email_address: + description: + - (Required for new resource) Email address of the approver + required: True + type: str billing_address_same_as_organization_flag: description: - billing address same as organization flag required: False type: bool default: False - technical_contact: - description: - - (Required for new resource) Technical contact info - required: True - type: list - elements: dict ssl_type: description: - (Required for new resource) ssl type required: True type: str - renewal_flag: - description: - - Renewal flag - required: False - type: bool - default: True - organization_information: + certificate_signing_request: description: - - (Required for new resource) Organization information + - (Required for new resource) certificate signing request info required: True - type: list - elements: dict - billing_contact_same_as_technical_flag: + type: str + administrative_contact_same_as_technical_flag: description: - - billing contact + - Administrative contact same as technical flag required: False type: bool default: False @@ -96,22 +90,28 @@ required: False type: bool default: False - server_count: + technical_contact: description: - - (Required for new resource) Server count + - (Required for new resource) Technical contact info required: True - type: int + type: list + elements: dict + billing_contact: + description: + - None + required: False + type: list + elements: dict server_type: description: - (Required for new resource) server type required: True type: str - administrative_contact_same_as_technical_flag: + validity_months: description: - - Administrative contact same as technical flag - required: False - type: bool - default: False + - (Required for new resource) vslidity of the ssl certificate in month + required: True + type: int id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -158,34 +158,34 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('validity_months', 'int'), - ('certificate_signing_request', 'str'), - ('order_approver_email_address', 'str'), - ('technical_contact', 'list'), - ('ssl_type', 'str'), ('organization_information', 'list'), ('server_count', 'int'), + ('order_approver_email_address', 'str'), + ('ssl_type', 'str'), + ('certificate_signing_request', 'str'), + ('technical_contact', 'list'), ('server_type', 'str'), + ('validity_months', 'int'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'validity_months', - 'certificate_signing_request', + 'billing_contact_same_as_technical_flag', 'administrative_contact', - 'billing_contact', - 'order_approver_email_address', + 'organization_information', + 'server_count', 'technical_contact_same_as_org_address_flag', + 'renewal_flag', + 'order_approver_email_address', 'billing_address_same_as_organization_flag', - 'technical_contact', 'ssl_type', - 'renewal_flag', - 'organization_information', - 'billing_contact_same_as_technical_flag', + 'certificate_signing_request', + 'administrative_contact_same_as_technical_flag', 'administrative_address_same_as_organization_flag', - 'server_count', + 'technical_contact', + 'billing_contact', 'server_type', - 'administrative_contact_same_as_technical_flag', + 'validity_months', ] # Params for Data source @@ -202,58 +202,58 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - validity_months=dict( - required=False, - type='int'), - certificate_signing_request=dict( + billing_contact_same_as_technical_flag=dict( required=False, - type='str'), + type='bool'), administrative_contact=dict( required=False, elements='', type='list'), - billing_contact=dict( + organization_information=dict( required=False, elements='', type='list'), - order_approver_email_address=dict( + server_count=dict( required=False, - type='str'), + type='int'), technical_contact_same_as_org_address_flag=dict( required=False, type='bool'), - billing_address_same_as_organization_flag=dict( + renewal_flag=dict( required=False, type='bool'), - technical_contact=dict( - required=False, - elements='', - type='list'), - ssl_type=dict( + order_approver_email_address=dict( required=False, type='str'), - renewal_flag=dict( + billing_address_same_as_organization_flag=dict( required=False, type='bool'), - organization_information=dict( + ssl_type=dict( required=False, - elements='', - type='list'), - billing_contact_same_as_technical_flag=dict( + type='str'), + certificate_signing_request=dict( + required=False, + type='str'), + administrative_contact_same_as_technical_flag=dict( required=False, type='bool'), administrative_address_same_as_organization_flag=dict( required=False, type='bool'), - server_count=dict( + technical_contact=dict( required=False, - type='int'), + elements='', + type='list'), + billing_contact=dict( + required=False, + elements='', + type='list'), server_type=dict( required=False, type='str'), - administrative_contact_same_as_technical_flag=dict( + validity_months=dict( required=False, - type='bool'), + type='int'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_storage_block.py b/plugins/modules/ibm_storage_block.py index 6611be4c7..9db35df4b 100644 --- a/plugins/modules/ibm_storage_block.py +++ b/plugins/modules/ibm_storage_block.py @@ -22,71 +22,71 @@ - Terraform v0.12.20 options: - snapshot_capacity: - description: - - Snapshot capacity in GB - required: False - type: int - allowed_hardware_ids: - description: - - List of allowe hardware IDs - required: False - type: list - elements: int allowed_virtual_guest_ids: description: - List of allowed virtual guest IDs required: False type: list elements: int - tags: + notes: description: - - List of tags associated with the resource + - Additional note info required: False - type: list - elements: str + type: str type: description: - (Required for new resource) Storage block type required: True type: str - iops: + snapshot_capacity: description: - - (Required for new resource) IOPS value required + - Snapshot capacity in GB + required: False + type: int + hourly_billing: + description: + - Billing done hourly, if set to true + required: False + type: bool + default: False + capacity: + description: + - (Required for new resource) Storage block size required: True - type: float + type: int allowed_ip_addresses: description: - Allowed IP addresses required: False type: list elements: str - hourly_billing: + allowed_hardware_ids: description: - - Billing done hourly, if set to true + - List of allowe hardware IDs required: False - type: bool - default: False + type: list + elements: int + tags: + description: + - List of tags associated with the resource + required: False + type: list + elements: str datacenter: description: - (Required for new resource) Datacenter name required: True type: str - capacity: - description: - - (Required for new resource) Storage block size - required: True - type: int os_format_type: description: - (Required for new resource) OS formatr type required: True type: str - notes: + iops: description: - - Additional note info - required: False - type: str + - (Required for new resource) IOPS value required + required: True + type: float id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -134,26 +134,26 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ ('type', 'str'), - ('iops', 'float'), - ('datacenter', 'str'), ('capacity', 'int'), + ('datacenter', 'str'), ('os_format_type', 'str'), + ('iops', 'float'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'snapshot_capacity', - 'allowed_hardware_ids', 'allowed_virtual_guest_ids', - 'tags', + 'notes', 'type', - 'iops', - 'allowed_ip_addresses', + 'snapshot_capacity', 'hourly_billing', - 'datacenter', 'capacity', + 'allowed_ip_addresses', + 'allowed_hardware_ids', + 'tags', + 'datacenter', 'os_format_type', - 'notes', + 'iops', ] # Params for Data source @@ -170,46 +170,46 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - snapshot_capacity=dict( - required=False, - type='int'), - allowed_hardware_ids=dict( - required=False, - elements='', - type='list'), allowed_virtual_guest_ids=dict( required=False, elements='', type='list'), - tags=dict( + notes=dict( required=False, - elements='', - type='list'), + type='str'), type=dict( required=False, type='str'), - iops=dict( + snapshot_capacity=dict( required=False, - type='float'), + type='int'), + hourly_billing=dict( + required=False, + type='bool'), + capacity=dict( + required=False, + type='int'), allowed_ip_addresses=dict( required=False, elements='', type='list'), - hourly_billing=dict( + allowed_hardware_ids=dict( required=False, - type='bool'), + elements='', + type='list'), + tags=dict( + required=False, + elements='', + type='list'), datacenter=dict( required=False, type='str'), - capacity=dict( - required=False, - type='int'), os_format_type=dict( required=False, type='str'), - notes=dict( + iops=dict( required=False, - type='str'), + type='float'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_storage_evault.py b/plugins/modules/ibm_storage_evault.py index 4aadf5159..e134db631 100644 --- a/plugins/modules/ibm_storage_evault.py +++ b/plugins/modules/ibm_storage_evault.py @@ -22,6 +22,12 @@ - Terraform v0.12.20 options: + tags: + description: + - Tags set for the resource + required: False + type: list + elements: str datacenter: description: - (Required for new resource) Datacenter name @@ -42,12 +48,6 @@ - Hardware instance ID required: False type: int - tags: - description: - - Tags set for the resource - required: False - type: list - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -100,11 +100,11 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'tags', 'datacenter', 'capacity', 'virtual_instance_id', 'hardware_instance_id', - 'tags', ] # Params for Data source @@ -123,6 +123,10 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + tags=dict( + required=False, + elements='', + type='list'), datacenter=dict( required=False, type='str'), @@ -135,10 +139,6 @@ hardware_instance_id=dict( required=False, type='int'), - tags=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_storage_file.py b/plugins/modules/ibm_storage_file.py index 7ea89438f..cfce3f16d 100644 --- a/plugins/modules/ibm_storage_file.py +++ b/plugins/modules/ibm_storage_file.py @@ -22,33 +22,26 @@ - Terraform v0.12.20 options: - datacenter: + type: description: - - (Required for new resource) Datacenter name + - (Required for new resource) Storage type required: True type: str - capacity: - description: - - (Required for new resource) Storage capacity - required: True - type: int - allowed_virtual_guest_ids: + snapshot_capacity: description: - - Virtual guest ID + - Snapshot capacity required: False - type: list - elements: int - allowed_hardware_ids: + type: int + notes: description: - - Hardaware ID + - Notes required: False - type: list - elements: int - iops: + type: str + capacity: description: - - (Required for new resource) iops rate + - (Required for new resource) Storage capacity required: True - type: float + type: int allowed_subnets: description: - Allowed network subnets @@ -61,11 +54,6 @@ required: False type: list elements: str - notes: - description: - - Notes - required: False - type: str snapshot_schedule: description: - None @@ -78,16 +66,28 @@ required: False type: list elements: str - type: + datacenter: description: - - (Required for new resource) Storage type + - (Required for new resource) Datacenter name required: True type: str - snapshot_capacity: + iops: description: - - Snapshot capacity + - (Required for new resource) iops rate + required: True + type: float + allowed_virtual_guest_ids: + description: + - Virtual guest ID required: False - type: int + type: list + elements: int + allowed_hardware_ids: + description: + - Hardaware ID + required: False + type: list + elements: int hourly_billing: description: - Hourly based billing type @@ -140,26 +140,26 @@ # Top level parameter keys required by Terraform module TL_REQUIRED_PARAMETERS = [ - ('datacenter', 'str'), + ('type', 'str'), ('capacity', 'int'), + ('datacenter', 'str'), ('iops', 'float'), - ('type', 'str'), ] # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'datacenter', + 'type', + 'snapshot_capacity', + 'notes', 'capacity', - 'allowed_virtual_guest_ids', - 'allowed_hardware_ids', - 'iops', 'allowed_subnets', 'allowed_ip_addresses', - 'notes', 'snapshot_schedule', 'tags', - 'type', - 'snapshot_capacity', + 'datacenter', + 'iops', + 'allowed_virtual_guest_ids', + 'allowed_hardware_ids', 'hourly_billing', ] @@ -177,23 +177,18 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - datacenter=dict( + type=dict( required=False, type='str'), - capacity=dict( + snapshot_capacity=dict( required=False, type='int'), - allowed_virtual_guest_ids=dict( - required=False, - elements='', - type='list'), - allowed_hardware_ids=dict( + notes=dict( required=False, - elements='', - type='list'), - iops=dict( + type='str'), + capacity=dict( required=False, - type='float'), + type='int'), allowed_subnets=dict( required=False, elements='', @@ -202,9 +197,6 @@ required=False, elements='', type='list'), - notes=dict( - required=False, - type='str'), snapshot_schedule=dict( required=False, elements='', @@ -213,12 +205,20 @@ required=False, elements='', type='list'), - type=dict( + datacenter=dict( required=False, type='str'), - snapshot_capacity=dict( + iops=dict( required=False, - type='int'), + type='float'), + allowed_virtual_guest_ids=dict( + required=False, + elements='', + type='list'), + allowed_hardware_ids=dict( + required=False, + elements='', + type='list'), hourly_billing=dict( required=False, type='bool'), diff --git a/plugins/modules/ibm_subnet.py b/plugins/modules/ibm_subnet.py index 9857b5605..e4c7880ee 100644 --- a/plugins/modules/ibm_subnet.py +++ b/plugins/modules/ibm_subnet.py @@ -22,27 +22,28 @@ - Terraform v0.12.20 options: + private: + description: + - private subnet + required: False + type: bool + default: False type: description: - (Required for new resource) subnet type required: True type: str - vlan_id: - description: - - VLAN ID for the subnet - required: False - type: int notes: description: - Notes required: False type: str - private: + tags: description: - - private subnet + - tags set for the resource required: False - type: bool - default: False + type: list + elements: str ip_version: description: - ip version @@ -54,17 +55,16 @@ - (Required for new resource) number of ip addresses in the subnet required: True type: int + vlan_id: + description: + - VLAN ID for the subnet + required: False + type: int endpoint_ip: description: - endpoint IP required: False type: str - tags: - description: - - tags set for the resource - required: False - type: list - elements: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -117,14 +117,14 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ + 'private', 'type', - 'vlan_id', 'notes', - 'private', + 'tags', 'ip_version', 'capacity', + 'vlan_id', 'endpoint_ip', - 'tags', ] # Params for Data source @@ -143,31 +143,31 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( + private=dict( + required=False, + type='bool'), type=dict( required=False, type='str'), - vlan_id=dict( - required=False, - type='int'), notes=dict( required=False, type='str'), - private=dict( + tags=dict( required=False, - type='bool'), + elements='', + type='list'), ip_version=dict( required=False, type='int'), capacity=dict( required=False, type='int'), + vlan_id=dict( + required=False, + type='int'), endpoint_ip=dict( required=False, type='str'), - tags=dict( - required=False, - elements='', - type='list'), id=dict( required=False, type='str'), diff --git a/plugins/modules/ibm_tg_connection.py b/plugins/modules/ibm_tg_connection.py index eb0c3e8e4..2d497413f 100644 --- a/plugins/modules/ibm_tg_connection.py +++ b/plugins/modules/ibm_tg_connection.py @@ -22,31 +22,51 @@ - Terraform v0.12.20 options: - remote_bgp_asn: + network_type: description: - - The remote network BGP ASN. This field only applies to network type 'gre_tunnel' connections. + - (Required for new resource) Defines what type of network is connected via this connection. Allowable values (classic,directlink,vpc,gre_tunnel) + required: True + type: str + base_connection_id: + description: + - The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type 'gre_tunnel' connections. required: False - type: int + type: str + local_tunnel_ip: + description: + - The local tunnel IP address. This field only applies to network type 'gre_tunnel' connections. + required: False + type: str remote_tunnel_ip: description: - The remote tunnel IP address. This field only applies to network type 'gre_tunnel' connections. required: False type: str - local_gateway_ip: + network_id: description: - - The local gateway IP address. This field only applies to network type 'gre_tunnel' connections. + - The ID of the network being connected via this connection. This field is required for some types, such as 'vpc' or 'directlink'. The value of this is the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type 'classic'. required: False type: str - network_type: + remote_bgp_asn: description: - - (Required for new resource) Defines what type of network is connected via this connection. Allowable values (classic,directlink,vpc,gre_tunnel) - required: True - type: str + - The remote network BGP ASN. This field only applies to network type 'gre_tunnel' connections. + required: False + type: int name: description: - The user-defined name for this transit gateway. If unspecified, the name will be the network name (the name of the VPC in the case of network type 'vpc', and the word Classic, in the case of network type 'classic'). required: False type: str + network_account_id: + description: + - The ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. + required: False + type: str + local_gateway_ip: + description: + - The local gateway IP address. This field only applies to network type 'gre_tunnel' connections. + required: False + type: str zone: description: - Location of GRE tunnel. This field only applies to network type 'gre_tunnel' connections. @@ -62,26 +82,6 @@ - The remote gateway IP address. This field only applies to network type 'gre_tunnel' connections. required: False type: str - network_id: - description: - - The ID of the network being connected via this connection. This field is required for some types, such as 'vpc' or 'directlink'. The value of this is the CRN of the VPC or direct link gateway to be connected. This field is required to be unspecified for network type 'classic'. - required: False - type: str - network_account_id: - description: - - The ID of the account which owns the network that is being connected. Generally only used if the network is in a different account than the gateway. - required: False - type: str - base_connection_id: - description: - - The ID of a network_type 'classic' connection a tunnel is configured over. This field only applies to network type 'gre_tunnel' connections. - required: False - type: str - local_tunnel_ip: - description: - - The local tunnel IP address. This field only applies to network type 'gre_tunnel' connections. - required: False - type: str id: description: - (Required when updating or destroying existing resource) IBM Cloud Resource ID. @@ -134,18 +134,18 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'remote_bgp_asn', - 'remote_tunnel_ip', - 'local_gateway_ip', 'network_type', + 'base_connection_id', + 'local_tunnel_ip', + 'remote_tunnel_ip', + 'network_id', + 'remote_bgp_asn', 'name', + 'network_account_id', + 'local_gateway_ip', 'zone', 'gateway', 'remote_gateway_ip', - 'network_id', - 'network_account_id', - 'base_connection_id', - 'local_tunnel_ip', ] # Params for Data source @@ -162,40 +162,40 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - remote_bgp_asn=dict( - required=False, - type='int'), - remote_tunnel_ip=dict( + network_type=dict( required=False, type='str'), - local_gateway_ip=dict( + base_connection_id=dict( required=False, type='str'), - network_type=dict( + local_tunnel_ip=dict( required=False, type='str'), - name=dict( + remote_tunnel_ip=dict( required=False, type='str'), - zone=dict( + network_id=dict( required=False, type='str'), - gateway=dict( + remote_bgp_asn=dict( + required=False, + type='int'), + name=dict( required=False, type='str'), - remote_gateway_ip=dict( + network_account_id=dict( required=False, type='str'), - network_id=dict( + local_gateway_ip=dict( required=False, type='str'), - network_account_id=dict( + zone=dict( required=False, type='str'), - base_connection_id=dict( + gateway=dict( required=False, type='str'), - local_tunnel_ip=dict( + remote_gateway_ip=dict( required=False, type='str'), id=dict( diff --git a/plugins/modules/ibm_tg_gateway.py b/plugins/modules/ibm_tg_gateway.py index f941eb094..42914cef3 100644 --- a/plugins/modules/ibm_tg_gateway.py +++ b/plugins/modules/ibm_tg_gateway.py @@ -22,28 +22,28 @@ - Terraform v0.12.20 options: - location: - description: - - (Required for new resource) Location of Transit Gateway Services - required: True - type: str - global_: - description: - - Allow global routing for a Transit Gateway. If unspecified, the default value is false - required: False - type: bool - default: False tags: description: - Tags for the transit gateway instance required: False type: list elements: str + location: + description: + - (Required for new resource) Location of Transit Gateway Services + required: True + type: str name: description: - (Required for new resource) Name Transit Gateway Services required: True type: str + global_: + description: + - Allow global routing for a Transit Gateway. If unspecified, the default value is false + required: False + type: bool + default: False resource_group: description: - None @@ -101,10 +101,10 @@ # All top level parameter keys supported by Terraform module TL_ALL_PARAMETERS = [ - 'location', - 'global_', 'tags', + 'location', 'name', + 'global_', 'resource_group', ] @@ -124,19 +124,19 @@ from ansible_collections.ibm.cloudcollection.plugins.module_utils.ibmcloud import Terraform, ibmcloud_terraform from ansible.module_utils.basic import env_fallback module_args = dict( - location=dict( - required=False, - type='str'), - global_=dict( - required=False, - type='bool'), tags=dict( required=False, elements='', type='list'), + location=dict( + required=False, + type='str'), name=dict( required=False, type='str'), + global_=dict( + required=False, + type='bool'), resource_group=dict( required=False, type='str'),