This repository has been archived by the owner on Mar 6, 2024. It is now read-only.

vCD Edge Gateway SSL Certificates

Jump to bottom

mukultaneja edited this page Feb 6, 2021 · 1 revision

vCD Edge Gateway SSL-Certificates Example Usage

SSL-Certificates States
- Add SSL-Certificates
```
 
     - name: add vCD edge gateway ssl-certificates
       vcd_gateway_services:
         vdc: ACME_PAYG
         gateway: edge-gateway
         service: ssl_certificates
         service_params:
            - cert_file_path: '/Users/mtaneja/Downloads/certificates/bob.crt'
              key_file_path: '/Users/mtaneja/Downloads/certificates/bob.key'
              cert_type: service
            - cert_file_path: '/Users/mtaneja/Downloads/certificates/carol.crt'
              key_file_path: '/Users/mtaneja/Downloads/certificates/carol.key'
              cert_type: service
         state: present
 
 
```
Argument Reference
- user - (Optional) - vCloud Director user name
- password - (Optional) - vCloud Director password
- org - (Optional) - vCloud Director org name to log into
- host - (Optional) - vCloud Director host name
- api_version - (Optional) - Pyvcloud API version
- verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
- vdc - (Required) name of vdc
- gateway - (Required) name of gateway
- service - (Required) name of service e.g "ssl_certificates"
- service_params - (Required) required arguments to create gateway service
  - cert_file_path - Service certificate file path. Required for all types of certificates
  - key_file_path - private key file path. Required only for "service" type certificates
  - key_passphrase - private key passphrase. Required only for "service" type certificates. Default: None
  - description - description for certificate
  - cert_type - type of certificate e.g "service/ca/crl"
- state - (Required) "present" to add vCD Edge gateway ssl certificate
- Delete SSL-Certificates
```
 
     - name: delete vCD edge gateway ssl-certificates
       vcd_gateway_services:
         vdc: ACME_PAYG
         gateway: edge-gateway
         service: ssl_certificates
         service_params:
            - cert_name: bob
              cert_type: service
         state: absent
 
 
```
Argument Reference
- user - (Optional) - vCloud Director user name
- password - (Optional) - vCloud Director password
- org - (Optional) - vCloud Director org name to log into
- host - (Optional) - vCloud Director host name
- api_version - (Optional) - Pyvcloud API version
- verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
- vdc - (Required) name of vdc
- gateway - (Required) name of gateway
- service - (Required) name of service e.g "ssl_certificates"
- service_params - (Required) required arguments to delete gateway service
  - cert_name - name of the certificate to delete
  - cert_type - type of certificate e.g "service/ca/crl"
- state - (Required) "absent" to delete vCD Edge gateway ssl certificate
SSL-Certificates Operations
- List SSL-Certificates
```
 
     - name: list vCD edge gateway ssl-certificates
       vcd_gateway_services:
         vdc: ACME_PAYG
         gateway: edge-gateway
         service: ssl_certificates
         operation: list
 
 
```
Argument Reference
- user - (Optional) - vCloud Director user name
- password - (Optional) - vCloud Director password
- org - (Optional) - vCloud Director org name to log into
- host - (Optional) - vCloud Director host name
- api_version - (Optional) - Pyvcloud API version
- verify_ssl_certs - (Optional) - true to enforce to verify ssl certificate for each requests else false
- vdc - (Required) name of vdc
- gateway - (Required) name of gateway
- service - (Required) name of service e.g "ssl_certificates"
- operation - (Required) "list" to list all available edge gateway ssl-certificates