vcd.SubscribedCatalog
Explore with Pulumi AI
Create SubscribedCatalog Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new SubscribedCatalog(name: string, args: SubscribedCatalogArgs, opts?: CustomResourceOptions);
@overload
def SubscribedCatalog(resource_name: str,
args: SubscribedCatalogArgs,
opts: Optional[ResourceOptions] = None)
@overload
def SubscribedCatalog(resource_name: str,
opts: Optional[ResourceOptions] = None,
subscription_url: Optional[str] = None,
subscribed_catalog_id: Optional[str] = None,
delete_force: Optional[bool] = None,
make_local_copy: Optional[bool] = None,
name: Optional[str] = None,
org: Optional[str] = None,
storage_profile_id: Optional[str] = None,
store_tasks: Optional[bool] = None,
cancel_failed_tasks: Optional[bool] = None,
delete_recursive: Optional[bool] = None,
sync_all: Optional[bool] = None,
subscription_password: Optional[str] = None,
sync_all_media_items: Optional[bool] = None,
sync_all_vapp_templates: Optional[bool] = None,
sync_catalog: Optional[bool] = None,
sync_media_items: Optional[Sequence[str]] = None,
sync_on_refresh: Optional[bool] = None,
sync_vapp_templates: Optional[Sequence[str]] = None)
func NewSubscribedCatalog(ctx *Context, name string, args SubscribedCatalogArgs, opts ...ResourceOption) (*SubscribedCatalog, error)
public SubscribedCatalog(string name, SubscribedCatalogArgs args, CustomResourceOptions? opts = null)
public SubscribedCatalog(String name, SubscribedCatalogArgs args)
public SubscribedCatalog(String name, SubscribedCatalogArgs args, CustomResourceOptions options)
type: vcd:SubscribedCatalog
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args SubscribedCatalogArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args SubscribedCatalogArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args SubscribedCatalogArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SubscribedCatalogArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SubscribedCatalogArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var subscribedCatalogResource = new Vcd.SubscribedCatalog("subscribedCatalogResource", new()
{
SubscriptionUrl = "string",
SubscribedCatalogId = "string",
DeleteForce = false,
MakeLocalCopy = false,
Name = "string",
Org = "string",
StorageProfileId = "string",
StoreTasks = false,
CancelFailedTasks = false,
DeleteRecursive = false,
SyncAll = false,
SubscriptionPassword = "string",
SyncAllMediaItems = false,
SyncAllVappTemplates = false,
SyncCatalog = false,
SyncMediaItems = new[]
{
"string",
},
SyncOnRefresh = false,
SyncVappTemplates = new[]
{
"string",
},
});
example, err := vcd.NewSubscribedCatalog(ctx, "subscribedCatalogResource", &vcd.SubscribedCatalogArgs{
SubscriptionUrl: pulumi.String("string"),
SubscribedCatalogId: pulumi.String("string"),
DeleteForce: pulumi.Bool(false),
MakeLocalCopy: pulumi.Bool(false),
Name: pulumi.String("string"),
Org: pulumi.String("string"),
StorageProfileId: pulumi.String("string"),
StoreTasks: pulumi.Bool(false),
CancelFailedTasks: pulumi.Bool(false),
DeleteRecursive: pulumi.Bool(false),
SyncAll: pulumi.Bool(false),
SubscriptionPassword: pulumi.String("string"),
SyncAllMediaItems: pulumi.Bool(false),
SyncAllVappTemplates: pulumi.Bool(false),
SyncCatalog: pulumi.Bool(false),
SyncMediaItems: pulumi.StringArray{
pulumi.String("string"),
},
SyncOnRefresh: pulumi.Bool(false),
SyncVappTemplates: pulumi.StringArray{
pulumi.String("string"),
},
})
var subscribedCatalogResource = new SubscribedCatalog("subscribedCatalogResource", SubscribedCatalogArgs.builder()
.subscriptionUrl("string")
.subscribedCatalogId("string")
.deleteForce(false)
.makeLocalCopy(false)
.name("string")
.org("string")
.storageProfileId("string")
.storeTasks(false)
.cancelFailedTasks(false)
.deleteRecursive(false)
.syncAll(false)
.subscriptionPassword("string")
.syncAllMediaItems(false)
.syncAllVappTemplates(false)
.syncCatalog(false)
.syncMediaItems("string")
.syncOnRefresh(false)
.syncVappTemplates("string")
.build());
subscribed_catalog_resource = vcd.SubscribedCatalog("subscribedCatalogResource",
subscription_url="string",
subscribed_catalog_id="string",
delete_force=False,
make_local_copy=False,
name="string",
org="string",
storage_profile_id="string",
store_tasks=False,
cancel_failed_tasks=False,
delete_recursive=False,
sync_all=False,
subscription_password="string",
sync_all_media_items=False,
sync_all_vapp_templates=False,
sync_catalog=False,
sync_media_items=["string"],
sync_on_refresh=False,
sync_vapp_templates=["string"])
const subscribedCatalogResource = new vcd.SubscribedCatalog("subscribedCatalogResource", {
subscriptionUrl: "string",
subscribedCatalogId: "string",
deleteForce: false,
makeLocalCopy: false,
name: "string",
org: "string",
storageProfileId: "string",
storeTasks: false,
cancelFailedTasks: false,
deleteRecursive: false,
syncAll: false,
subscriptionPassword: "string",
syncAllMediaItems: false,
syncAllVappTemplates: false,
syncCatalog: false,
syncMediaItems: ["string"],
syncOnRefresh: false,
syncVappTemplates: ["string"],
});
type: vcd:SubscribedCatalog
properties:
cancelFailedTasks: false
deleteForce: false
deleteRecursive: false
makeLocalCopy: false
name: string
org: string
storageProfileId: string
storeTasks: false
subscribedCatalogId: string
subscriptionPassword: string
subscriptionUrl: string
syncAll: false
syncAllMediaItems: false
syncAllVappTemplates: false
syncCatalog: false
syncMediaItems:
- string
syncOnRefresh: false
syncVappTemplates:
- string
SubscribedCatalog Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The SubscribedCatalog resource accepts the following input properties:
- Subscription
Url string - The URL to subscribe to the external catalog.
- Cancel
Failed boolTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - Delete
Force bool - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - Delete
Recursive bool - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - Make
Local boolCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - Name string
- Catalog name
- Org string
- The name of organization to use, optional if defined at provider level.
- Storage
Profile stringId - Allows to set specific storage profile to be used for catalog.
- Store
Tasks bool - if
true
, saves the list of tasks to a file for later update. - Subscribed
Catalog stringId - Subscription
Password string - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- Sync
All bool - If
true
, synchronise this catalog and all items. - Sync
All boolMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - Sync
All boolVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - Sync
Catalog bool - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - Sync
Media List<string>Items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - Sync
On boolRefresh - Boolean value that shows if sync should be performed on every refresh.
- Sync
Vapp List<string>Templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set.
- Subscription
Url string - The URL to subscribe to the external catalog.
- Cancel
Failed boolTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - Delete
Force bool - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - Delete
Recursive bool - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - Make
Local boolCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - Name string
- Catalog name
- Org string
- The name of organization to use, optional if defined at provider level.
- Storage
Profile stringId - Allows to set specific storage profile to be used for catalog.
- Store
Tasks bool - if
true
, saves the list of tasks to a file for later update. - Subscribed
Catalog stringId - Subscription
Password string - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- Sync
All bool - If
true
, synchronise this catalog and all items. - Sync
All boolMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - Sync
All boolVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - Sync
Catalog bool - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - Sync
Media []stringItems - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - Sync
On boolRefresh - Boolean value that shows if sync should be performed on every refresh.
- Sync
Vapp []stringTemplates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set.
- subscription
Url String - The URL to subscribe to the external catalog.
- cancel
Failed BooleanTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - delete
Force Boolean - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - delete
Recursive Boolean - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - make
Local BooleanCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - name String
- Catalog name
- org String
- The name of organization to use, optional if defined at provider level.
- storage
Profile StringId - Allows to set specific storage profile to be used for catalog.
- store
Tasks Boolean - if
true
, saves the list of tasks to a file for later update. - subscribed
Catalog StringId - subscription
Password String - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- sync
All Boolean - If
true
, synchronise this catalog and all items. - sync
All BooleanMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - sync
All BooleanVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - sync
Catalog Boolean - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - sync
Media List<String>Items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - sync
On BooleanRefresh - Boolean value that shows if sync should be performed on every refresh.
- sync
Vapp List<String>Templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set.
- subscription
Url string - The URL to subscribe to the external catalog.
- cancel
Failed booleanTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - delete
Force boolean - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - delete
Recursive boolean - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - make
Local booleanCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - name string
- Catalog name
- org string
- The name of organization to use, optional if defined at provider level.
- storage
Profile stringId - Allows to set specific storage profile to be used for catalog.
- store
Tasks boolean - if
true
, saves the list of tasks to a file for later update. - subscribed
Catalog stringId - subscription
Password string - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- sync
All boolean - If
true
, synchronise this catalog and all items. - sync
All booleanMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - sync
All booleanVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - sync
Catalog boolean - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - sync
Media string[]Items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - sync
On booleanRefresh - Boolean value that shows if sync should be performed on every refresh.
- sync
Vapp string[]Templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set.
- subscription_
url str - The URL to subscribe to the external catalog.
- cancel_
failed_ booltasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - delete_
force bool - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - delete_
recursive bool - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - make_
local_ boolcopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - name str
- Catalog name
- org str
- The name of organization to use, optional if defined at provider level.
- storage_
profile_ strid - Allows to set specific storage profile to be used for catalog.
- store_
tasks bool - if
true
, saves the list of tasks to a file for later update. - subscribed_
catalog_ strid - subscription_
password str - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- sync_
all bool - If
true
, synchronise this catalog and all items. - sync_
all_ boolmedia_ items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - sync_
all_ boolvapp_ templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - sync_
catalog bool - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - sync_
media_ Sequence[str]items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - sync_
on_ boolrefresh - Boolean value that shows if sync should be performed on every refresh.
- sync_
vapp_ Sequence[str]templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set.
- subscription
Url String - The URL to subscribe to the external catalog.
- cancel
Failed BooleanTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - delete
Force Boolean - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - delete
Recursive Boolean - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - make
Local BooleanCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - name String
- Catalog name
- org String
- The name of organization to use, optional if defined at provider level.
- storage
Profile StringId - Allows to set specific storage profile to be used for catalog.
- store
Tasks Boolean - if
true
, saves the list of tasks to a file for later update. - subscribed
Catalog StringId - subscription
Password String - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- sync
All Boolean - If
true
, synchronise this catalog and all items. - sync
All BooleanMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - sync
All BooleanVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - sync
Catalog Boolean - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - sync
Media List<String>Items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - sync
On BooleanRefresh - Boolean value that shows if sync should be performed on every refresh.
- sync
Vapp List<String>Templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set.
Outputs
All input properties are implicitly available as output properties. Additionally, the SubscribedCatalog resource produces the following output properties:
- Catalog
Version double - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- Created string
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- Description string
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- Failed
Tasks List<string> - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- Href string
- the catalog's Hyper reference.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Local bool - (v3.8.1+) Indicates if this catalog was created in the current organization.
- Is
Published bool - Indicates if this catalog is available for subscription. (Always false)
- bool
- Indicates if the catalog is shared.
- Media
Item List<string>Lists - List of media item names in this catalog, in alphabetical order.
- Metadata Dictionary<string, string>
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- Number
Of doubleMedia - Number of media items available in this catalog.
- Number
Of doubleVapp Templates - Number of vApp templates available in this catalog.
- Owner
Name string - Owner of the catalog.
- Publish
Subscription stringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - Running
Tasks List<string> - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- Tasks
File stringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - Vapp
Template List<string>Lists - List of vApp template names in this catalog, in alphabetical order.
- Catalog
Version float64 - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- Created string
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- Description string
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- Failed
Tasks []string - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- Href string
- the catalog's Hyper reference.
- Id string
- The provider-assigned unique ID for this managed resource.
- Is
Local bool - (v3.8.1+) Indicates if this catalog was created in the current organization.
- Is
Published bool - Indicates if this catalog is available for subscription. (Always false)
- bool
- Indicates if the catalog is shared.
- Media
Item []stringLists - List of media item names in this catalog, in alphabetical order.
- Metadata map[string]string
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- Number
Of float64Media - Number of media items available in this catalog.
- Number
Of float64Vapp Templates - Number of vApp templates available in this catalog.
- Owner
Name string - Owner of the catalog.
- Publish
Subscription stringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - Running
Tasks []string - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- Tasks
File stringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - Vapp
Template []stringLists - List of vApp template names in this catalog, in alphabetical order.
- catalog
Version Double - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- created String
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- description String
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- failed
Tasks List<String> - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- href String
- the catalog's Hyper reference.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Local Boolean - (v3.8.1+) Indicates if this catalog was created in the current organization.
- is
Published Boolean - Indicates if this catalog is available for subscription. (Always false)
- Boolean
- Indicates if the catalog is shared.
- media
Item List<String>Lists - List of media item names in this catalog, in alphabetical order.
- metadata Map<String,String>
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- number
Of DoubleMedia - Number of media items available in this catalog.
- number
Of DoubleVapp Templates - Number of vApp templates available in this catalog.
- owner
Name String - Owner of the catalog.
- publish
Subscription StringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - running
Tasks List<String> - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- tasks
File StringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - vapp
Template List<String>Lists - List of vApp template names in this catalog, in alphabetical order.
- catalog
Version number - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- created string
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- description string
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- failed
Tasks string[] - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- href string
- the catalog's Hyper reference.
- id string
- The provider-assigned unique ID for this managed resource.
- is
Local boolean - (v3.8.1+) Indicates if this catalog was created in the current organization.
- is
Published boolean - Indicates if this catalog is available for subscription. (Always false)
- boolean
- Indicates if the catalog is shared.
- media
Item string[]Lists - List of media item names in this catalog, in alphabetical order.
- metadata {[key: string]: string}
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- number
Of numberMedia - Number of media items available in this catalog.
- number
Of numberVapp Templates - Number of vApp templates available in this catalog.
- owner
Name string - Owner of the catalog.
- publish
Subscription stringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - running
Tasks string[] - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- tasks
File stringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - vapp
Template string[]Lists - List of vApp template names in this catalog, in alphabetical order.
- catalog_
version float - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- created str
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- description str
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- failed_
tasks Sequence[str] - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- href str
- the catalog's Hyper reference.
- id str
- The provider-assigned unique ID for this managed resource.
- is_
local bool - (v3.8.1+) Indicates if this catalog was created in the current organization.
- is_
published bool - Indicates if this catalog is available for subscription. (Always false)
- bool
- Indicates if the catalog is shared.
- media_
item_ Sequence[str]lists - List of media item names in this catalog, in alphabetical order.
- metadata Mapping[str, str]
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- number_
of_ floatmedia - Number of media items available in this catalog.
- number_
of_ floatvapp_ templates - Number of vApp templates available in this catalog.
- owner_
name str - Owner of the catalog.
- publish_
subscription_ strtype - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - running_
tasks Sequence[str] - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- tasks_
file_ strname - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - vapp_
template_ Sequence[str]lists - List of vApp template names in this catalog, in alphabetical order.
- catalog
Version Number - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- created String
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- description String
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- failed
Tasks List<String> - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- href String
- the catalog's Hyper reference.
- id String
- The provider-assigned unique ID for this managed resource.
- is
Local Boolean - (v3.8.1+) Indicates if this catalog was created in the current organization.
- is
Published Boolean - Indicates if this catalog is available for subscription. (Always false)
- Boolean
- Indicates if the catalog is shared.
- media
Item List<String>Lists - List of media item names in this catalog, in alphabetical order.
- metadata Map<String>
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- number
Of NumberMedia - Number of media items available in this catalog.
- number
Of NumberVapp Templates - Number of vApp templates available in this catalog.
- owner
Name String - Owner of the catalog.
- publish
Subscription StringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - running
Tasks List<String> - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- tasks
File StringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - vapp
Template List<String>Lists - List of vApp template names in this catalog, in alphabetical order.
Look up Existing SubscribedCatalog Resource
Get an existing SubscribedCatalog resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: SubscribedCatalogState, opts?: CustomResourceOptions): SubscribedCatalog
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
cancel_failed_tasks: Optional[bool] = None,
catalog_version: Optional[float] = None,
created: Optional[str] = None,
delete_force: Optional[bool] = None,
delete_recursive: Optional[bool] = None,
description: Optional[str] = None,
failed_tasks: Optional[Sequence[str]] = None,
href: Optional[str] = None,
is_local: Optional[bool] = None,
is_published: Optional[bool] = None,
is_shared: Optional[bool] = None,
make_local_copy: Optional[bool] = None,
media_item_lists: Optional[Sequence[str]] = None,
metadata: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
number_of_media: Optional[float] = None,
number_of_vapp_templates: Optional[float] = None,
org: Optional[str] = None,
owner_name: Optional[str] = None,
publish_subscription_type: Optional[str] = None,
running_tasks: Optional[Sequence[str]] = None,
storage_profile_id: Optional[str] = None,
store_tasks: Optional[bool] = None,
subscribed_catalog_id: Optional[str] = None,
subscription_password: Optional[str] = None,
subscription_url: Optional[str] = None,
sync_all: Optional[bool] = None,
sync_all_media_items: Optional[bool] = None,
sync_all_vapp_templates: Optional[bool] = None,
sync_catalog: Optional[bool] = None,
sync_media_items: Optional[Sequence[str]] = None,
sync_on_refresh: Optional[bool] = None,
sync_vapp_templates: Optional[Sequence[str]] = None,
tasks_file_name: Optional[str] = None,
vapp_template_lists: Optional[Sequence[str]] = None) -> SubscribedCatalog
func GetSubscribedCatalog(ctx *Context, name string, id IDInput, state *SubscribedCatalogState, opts ...ResourceOption) (*SubscribedCatalog, error)
public static SubscribedCatalog Get(string name, Input<string> id, SubscribedCatalogState? state, CustomResourceOptions? opts = null)
public static SubscribedCatalog get(String name, Output<String> id, SubscribedCatalogState state, CustomResourceOptions options)
resources: _: type: vcd:SubscribedCatalog get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Cancel
Failed boolTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - Catalog
Version double - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- Created string
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- Delete
Force bool - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - Delete
Recursive bool - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - Description string
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- Failed
Tasks List<string> - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- Href string
- the catalog's Hyper reference.
- Is
Local bool - (v3.8.1+) Indicates if this catalog was created in the current organization.
- Is
Published bool - Indicates if this catalog is available for subscription. (Always false)
- bool
- Indicates if the catalog is shared.
- Make
Local boolCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - Media
Item List<string>Lists - List of media item names in this catalog, in alphabetical order.
- Metadata Dictionary<string, string>
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- Name string
- Catalog name
- Number
Of doubleMedia - Number of media items available in this catalog.
- Number
Of doubleVapp Templates - Number of vApp templates available in this catalog.
- Org string
- The name of organization to use, optional if defined at provider level.
- Owner
Name string - Owner of the catalog.
- Publish
Subscription stringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - Running
Tasks List<string> - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- Storage
Profile stringId - Allows to set specific storage profile to be used for catalog.
- Store
Tasks bool - if
true
, saves the list of tasks to a file for later update. - Subscribed
Catalog stringId - Subscription
Password string - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- Subscription
Url string - The URL to subscribe to the external catalog.
- Sync
All bool - If
true
, synchronise this catalog and all items. - Sync
All boolMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - Sync
All boolVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - Sync
Catalog bool - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - Sync
Media List<string>Items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - Sync
On boolRefresh - Boolean value that shows if sync should be performed on every refresh.
- Sync
Vapp List<string>Templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set. - Tasks
File stringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - Vapp
Template List<string>Lists - List of vApp template names in this catalog, in alphabetical order.
- Cancel
Failed boolTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - Catalog
Version float64 - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- Created string
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- Delete
Force bool - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - Delete
Recursive bool - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - Description string
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- Failed
Tasks []string - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- Href string
- the catalog's Hyper reference.
- Is
Local bool - (v3.8.1+) Indicates if this catalog was created in the current organization.
- Is
Published bool - Indicates if this catalog is available for subscription. (Always false)
- bool
- Indicates if the catalog is shared.
- Make
Local boolCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - Media
Item []stringLists - List of media item names in this catalog, in alphabetical order.
- Metadata map[string]string
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- Name string
- Catalog name
- Number
Of float64Media - Number of media items available in this catalog.
- Number
Of float64Vapp Templates - Number of vApp templates available in this catalog.
- Org string
- The name of organization to use, optional if defined at provider level.
- Owner
Name string - Owner of the catalog.
- Publish
Subscription stringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - Running
Tasks []string - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- Storage
Profile stringId - Allows to set specific storage profile to be used for catalog.
- Store
Tasks bool - if
true
, saves the list of tasks to a file for later update. - Subscribed
Catalog stringId - Subscription
Password string - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- Subscription
Url string - The URL to subscribe to the external catalog.
- Sync
All bool - If
true
, synchronise this catalog and all items. - Sync
All boolMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - Sync
All boolVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - Sync
Catalog bool - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - Sync
Media []stringItems - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - Sync
On boolRefresh - Boolean value that shows if sync should be performed on every refresh.
- Sync
Vapp []stringTemplates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set. - Tasks
File stringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - Vapp
Template []stringLists - List of vApp template names in this catalog, in alphabetical order.
- cancel
Failed BooleanTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - catalog
Version Double - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- created String
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- delete
Force Boolean - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - delete
Recursive Boolean - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - description String
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- failed
Tasks List<String> - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- href String
- the catalog's Hyper reference.
- is
Local Boolean - (v3.8.1+) Indicates if this catalog was created in the current organization.
- is
Published Boolean - Indicates if this catalog is available for subscription. (Always false)
- Boolean
- Indicates if the catalog is shared.
- make
Local BooleanCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - media
Item List<String>Lists - List of media item names in this catalog, in alphabetical order.
- metadata Map<String,String>
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- name String
- Catalog name
- number
Of DoubleMedia - Number of media items available in this catalog.
- number
Of DoubleVapp Templates - Number of vApp templates available in this catalog.
- org String
- The name of organization to use, optional if defined at provider level.
- owner
Name String - Owner of the catalog.
- publish
Subscription StringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - running
Tasks List<String> - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- storage
Profile StringId - Allows to set specific storage profile to be used for catalog.
- store
Tasks Boolean - if
true
, saves the list of tasks to a file for later update. - subscribed
Catalog StringId - subscription
Password String - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- subscription
Url String - The URL to subscribe to the external catalog.
- sync
All Boolean - If
true
, synchronise this catalog and all items. - sync
All BooleanMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - sync
All BooleanVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - sync
Catalog Boolean - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - sync
Media List<String>Items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - sync
On BooleanRefresh - Boolean value that shows if sync should be performed on every refresh.
- sync
Vapp List<String>Templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set. - tasks
File StringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - vapp
Template List<String>Lists - List of vApp template names in this catalog, in alphabetical order.
- cancel
Failed booleanTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - catalog
Version number - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- created string
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- delete
Force boolean - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - delete
Recursive boolean - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - description string
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- failed
Tasks string[] - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- href string
- the catalog's Hyper reference.
- is
Local boolean - (v3.8.1+) Indicates if this catalog was created in the current organization.
- is
Published boolean - Indicates if this catalog is available for subscription. (Always false)
- boolean
- Indicates if the catalog is shared.
- make
Local booleanCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - media
Item string[]Lists - List of media item names in this catalog, in alphabetical order.
- metadata {[key: string]: string}
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- name string
- Catalog name
- number
Of numberMedia - Number of media items available in this catalog.
- number
Of numberVapp Templates - Number of vApp templates available in this catalog.
- org string
- The name of organization to use, optional if defined at provider level.
- owner
Name string - Owner of the catalog.
- publish
Subscription stringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - running
Tasks string[] - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- storage
Profile stringId - Allows to set specific storage profile to be used for catalog.
- store
Tasks boolean - if
true
, saves the list of tasks to a file for later update. - subscribed
Catalog stringId - subscription
Password string - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- subscription
Url string - The URL to subscribe to the external catalog.
- sync
All boolean - If
true
, synchronise this catalog and all items. - sync
All booleanMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - sync
All booleanVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - sync
Catalog boolean - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - sync
Media string[]Items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - sync
On booleanRefresh - Boolean value that shows if sync should be performed on every refresh.
- sync
Vapp string[]Templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set. - tasks
File stringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - vapp
Template string[]Lists - List of vApp template names in this catalog, in alphabetical order.
- cancel_
failed_ booltasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - catalog_
version float - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- created str
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- delete_
force bool - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - delete_
recursive bool - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - description str
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- failed_
tasks Sequence[str] - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- href str
- the catalog's Hyper reference.
- is_
local bool - (v3.8.1+) Indicates if this catalog was created in the current organization.
- is_
published bool - Indicates if this catalog is available for subscription. (Always false)
- bool
- Indicates if the catalog is shared.
- make_
local_ boolcopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - media_
item_ Sequence[str]lists - List of media item names in this catalog, in alphabetical order.
- metadata Mapping[str, str]
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- name str
- Catalog name
- number_
of_ floatmedia - Number of media items available in this catalog.
- number_
of_ floatvapp_ templates - Number of vApp templates available in this catalog.
- org str
- The name of organization to use, optional if defined at provider level.
- owner_
name str - Owner of the catalog.
- publish_
subscription_ strtype - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - running_
tasks Sequence[str] - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- storage_
profile_ strid - Allows to set specific storage profile to be used for catalog.
- store_
tasks bool - if
true
, saves the list of tasks to a file for later update. - subscribed_
catalog_ strid - subscription_
password str - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- subscription_
url str - The URL to subscribe to the external catalog.
- sync_
all bool - If
true
, synchronise this catalog and all items. - sync_
all_ boolmedia_ items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - sync_
all_ boolvapp_ templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - sync_
catalog bool - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - sync_
media_ Sequence[str]items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - sync_
on_ boolrefresh - Boolean value that shows if sync should be performed on every refresh.
- sync_
vapp_ Sequence[str]templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set. - tasks_
file_ strname - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - vapp_
template_ Sequence[str]lists - List of vApp template names in this catalog, in alphabetical order.
- cancel
Failed BooleanTasks - When
true
, the subscribed catalog will attempt canceling failed tasks. - catalog
Version Number - Version number from this catalog. This is inherited from the publishing catalog and updated on sync.
- created String
- Date and time of catalog creation. This is the creation date of the subscription, not the original published catalog.
- delete
Force Boolean - When destroying use
delete_force=true
withdelete_recursive=true
to remove a catalog and any objects it contains, regardless of their state. - delete
Recursive Boolean - When destroying use
delete_recursive=true
to remove the catalog and any objects it contains that are in a state that normally allows removal. - description String
- Description of catalog. This is inherited from the publishing catalog and updated on sync.
- failed
Tasks List<String> - List of synchronization tasks that are have failed. They can refer to the catalog or any of its catalog items.
- href String
- the catalog's Hyper reference.
- is
Local Boolean - (v3.8.1+) Indicates if this catalog was created in the current organization.
- is
Published Boolean - Indicates if this catalog is available for subscription. (Always false)
- Boolean
- Indicates if the catalog is shared.
- make
Local BooleanCopy - If
true
, subscription to a catalog creates a local copy of all items. Defaults tofalse
, which does not create a local copy of catalog items unless a sync operation is performed. It can only befalse
if the user configured in the provider is the System administrator. - media
Item List<String>Lists - List of media item names in this catalog, in alphabetical order.
- metadata Map<String>
- (Available until VCD 10.5) Optional metadata of the catalog. This is inherited from the publishing catalog and updated on sync.
- name String
- Catalog name
- number
Of NumberMedia - Number of media items available in this catalog.
- number
Of NumberVapp Templates - Number of vApp templates available in this catalog.
- org String
- The name of organization to use, optional if defined at provider level.
- owner
Name String - Owner of the catalog.
- publish
Subscription StringType - Shows if the catalog is published, if it is a subscription from another one or none of those. (Always
SUBSCRIBED
) - running
Tasks List<String> - List of running synchronization tasks that are still running. They can refer to the catalog or any of its catalog items.
- storage
Profile StringId - Allows to set specific storage profile to be used for catalog.
- store
Tasks Boolean - if
true
, saves the list of tasks to a file for later update. - subscribed
Catalog StringId - subscription
Password String - An optional password to access the catalog. Only ASCII characters are allowed in a valid password. The password is only required when set by the publishing catalog. Passing in six asterisks '******' indicates to keep current password. Passing in an empty string indicates to remove password.
- subscription
Url String - The URL to subscribe to the external catalog.
- sync
All Boolean - If
true
, synchronise this catalog and all items. - sync
All BooleanMedia Items - If
true
, synchronise all media items. Not to be used whensync_all
is set. - sync
All BooleanVapp Templates - If
true
, synchronise all vApp templates. Not to be used whensync_all
is set. - sync
Catalog Boolean - If
true
, synchronise this catalog. Not to be used whensync_all
is set. This operation fetches the list of items. Ifmake_local_copy
is set, it also synchronises all the items. - sync
Media List<String>Items - Synchronise a list of media items. Not to be used when
sync_all
orsync_all_media_items
are set. - sync
On BooleanRefresh - Boolean value that shows if sync should be performed on every refresh.
- sync
Vapp List<String>Templates - Synchronise a list of vApp templates. Not to be used when
sync_all
orsync_all_vapp_templates
are set. - tasks
File StringName - Where the running tasks IDs have been stored. Only if
store_tasks
is set. - vapp
Template List<String>Lists - List of vApp template names in this catalog, in alphabetical order.
Package Details
- Repository
- vcd vmware/terraform-provider-vcd
- License
- Notes
- This Pulumi package is based on the
vcd
Terraform Provider.