vCD Catalog Item

Catalog Item Example Usage

1. Catalog Item States

   Upload Catalog Media/Ova

   
    - name: upload media
      vcd_catalog_item:
       catalog_name: "test_catalog"
       item_name: "test_item_media"
       file_name: "test_item_media.iso"
       chunk_size: 1048576
       description: "test_description"
       state: "present"
   
   

   
    - name: upload ova
      vcd_catalog_item:
       catalog_name: "test_catalog"
       item_name: "test_item_ova"
       file_name: "test_item_ova.ova"
       chunk_size: 1048576
       description: "test_description"
       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
   • catalog_name - (Required) Name of the catalog
   • item_name - (Required) Name for the catalog media/ova
   • file_name - (Required) Path of the catalog media/ova file
   • chunk_size - (Optional) Size of chunks in which the file will be uploaded to the catalog
   • description - (Optional) catalog item description
   • state == "present" (Required) to upload catalog media/ova

   ---

   Delete Catalog Media/Ova

   
    - name: delete media
      vcd_catalog_item:
       catalog_name: "test_catalog"
       item_name: "test_media_item"
       state: "absent"
   
   

   
    - name: delete ova
      vcd_catalog_item:
       catalog_name: "test_catalog"
       item_name: "test_ova_item"
       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
   • catalog_name - (Required) Name of the catalog
   • item_name - (Required) Name for the catalog media/ova
   • state == "absent" (Required) to delete catalog media/ova

---

2. Catalog Item Operations

   Capture Vapp

   
     - name: capture vapp
       vcd_catalog_item:
        catalog_name: "test_catalog"
        item_name: "test_item"
        vapp_name: "test_vapp"
        vdc_name: "test_vdc"
        description: "test_description"
        customize_on_instantiate: false
        overwrite: false
        operation: "capturevapp"
   
   

   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
   • catalog_name - (Required) Name of the catalog
   • item_name - (Required) Name of the catalog media/ova inside a catalog
   • vapp_name - (Required) Name of the vApp to capture
   • vdc_name - (Required) Name of the vdc
   • description - (Optional) Description of the catalog item
   • customize_on_instantiate - (Optional) true/false, Flag indicating if the vApp to be instantiated from this vApp template can be customized. The default value is false.
   • overwrite - (Optional) true/false, Flag indicating if the item in the catalog has to be overwritten if it already exists. If it doesn't exist, this flag is not used. The default value is false
   • operation == "capturevapp" (Required) to capture vApp as a template into a catalog

   ---

   List Catalog Item vms

   
     - name: list catalog item vms
       vcd_catalog_item:
        catalog_name: "test_catalog"
        item_name: "test_item"
        description: "test_description"
        operation: "list_vms"
   
   

   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
   • catalog_name - (Required) Name of the catalog
   • item_name - (Required) Name of the catalog media/ova
   • description - (Optional) Description of the catalog item
   • operation == "list_vms" (Required) to list catalog item vms