Skip to content

Latest commit

 

History

History
42 lines (38 loc) · 5.31 KB

AssocTargetItem.md

File metadata and controls

42 lines (38 loc) · 5.31 KB

AssocTargetItem

assocTargetItem is a command that creates an association between target and item.

Properties

Name Type Description Notes
bind_ssl_profiles list[str] Bind the provisioned certificate to an existing client-ssl/server-ssl profile, in the format <type>:<partition>:<name> (relevant only for F5 BIG-IP certificate provisioning). Leave the partition empty to use the certificate's partition. For a profile in a folder, add the folder to the partition, for example client-ssl:Common/Shared:my-profile. Repeat the parameter to bind several profiles. [optional]
certificate_arn str The ARN of an existing imported ACM certificate to re-import into, which replaces its certificate and key; if empty, a new ACM certificate is created on every provisioning, including after renewal (relevant only for AWS certificate provisioning) [optional]
certificate_format str The format the certificate will be provisioned with, available options: pem,pfx (relevant only for certificate provisioning) [optional] [default to 'pem']
certificate_name str The name of the certificate object in the cloud provider (relevant only for AWS, Azure, and GCP certificate provisioning) [optional]
certificate_path str A path on the target to store the certificate pem file (relevant only for certificate provisioning) [optional]
chain_path str A path on the target to store the full chain pem file (relevant only for certificate provisioning) [optional]
disable_previous_key_version bool Automatically disable previous key version (required for azure targets) [optional] [default to False]
external_key_name str The external key name to associate with the classic key (Relevant only for Classic Key AWS/Azure/GCP targets) [optional]
f5_save_config bool Save the F5 running configuration after each successful provisioning, so the certificate survives a reboot. This also saves any other unsaved change on the device (relevant only for F5 BIG-IP certificate provisioning) [optional] [default to False]
f5_sync_device_group str Sync the F5 configuration to this device group after each successful provisioning, so the HA peer serves the same certificate. This overwrites unsynced changes on the other members of the group. Implies f5-save-config (relevant only for F5 BIG-IP certificate provisioning) [optional]
json bool Set output format to JSON [optional] [default to False]
key_operations list[str] A list of allowed operations for the key (required for azure targets) [optional]
key_vault str The Azure Key Vault name to provision the certificate to (relevant only for Azure certificate provisioning) [optional]
keyring_name str Keyring name of the GCP KMS (required for gcp targets) [optional]
kms_algorithm str Algorithm of the key in GCP KMS (required for gcp targets) [optional]
location_id str Location id of the GCP KMS (required for gcp targets) [optional]
location_scope str The GCP Certificate Manager location to provision the certificate to: global or a region such as us-central1 (relevant only for GCP certificate provisioning) [optional]
multi_region str Set to 'true' to create a multi-region managed key. (Relevant only for Classic Key AWS targets) [optional] [default to 'false']
name str The item to associate
pfx_password str Password used to protect the provisioned PFX file. Required when --certificate-format=pfx (relevant only for certificate provisioning) [optional]
post_provision_command str A custom command to run on the remote target after successful provisioning (relevant only for SSH and Windows certificate provisioning, not supported for F5 BIG-IP) [optional]
private_key_path str A path on the target to store the private key (relevant only for certificate provisioning) [optional]
project_id str Project id of the GCP KMS (required for gcp targets) [optional]
protection_level str Protection level of the key [software/hardware] (relevant for gcp targets) [optional] [default to 'software']
purpose str Purpose of the key in GCP KMS (required for gcp targets) [optional]
regions list[str] The list of regions to create a copy of the key in (relevant for aws targets) [optional]
sra_association bool Is the target to associate is for sra, relevant only for linked target association for ldap rotated secret [optional] [default to False]
target_name str The target to associate
tenant_secret_type str The tenant secret type [Data/SearchIndex/Analytics] (required for salesforce targets) [optional]
token str Authentication token (see `/auth` and `/configure`) [optional]
uid_token str The universal identity token, Required only for universal_identity authentication [optional]
vault_name str Name of the vault used (required for azure targets) [optional]

[Back to Model list] [Back to API list] [Back to README]