pyvcloud.vcd.system module

class pyvcloud.vcd.system.System(client, admin_href=None, admin_resource=None)

Bases: object

create_org(org_name, full_org_name, is_enabled=False)

Create new organization.

Parameters:
  • org_name (str) – name of the organization.
  • full_org_name (str) – full name of the organization.
  • is_enabled (bool) – enable organization if True
Returns:

an object containing EntityType.ADMIN_ORG XML data which represents the newly created organization.

Return type:

lxml.objectify.ObjectifiedElement

delete_org(org_name, force=None, recursive=None)

Delete an organization.

Parameters:
  • org_name (str) – name of the org to be deleted.
  • force (bool) – pass force=True along with recursive=True to remove an organization and any objects it contains, regardless of their state.
  • recursive (bool) – pass recursive=True to remove an organization and any objects it contains that are in a state that normally allows removal.
get_network_pool_reference(name)

Return a network pool by name in the system organization.

Returns:an object containing NetworkPoolReference XML element.
Return type:lxml.objectify.ObjectifiedElement
Raises:EntityNotFoundException: if the named network pool can not be found.
get_provider_vdc(name)

Fetch a provider VDC by name in the system organization.

Returns:an object containing ProviderVdcReference XML element which refers to the provider vdc.
Return type:lxml.objectify.ObjectifiedElement
Raises:EntityNotFoundException: if the named provider vdc can not be found.
get_provider_vdc_storage_profile(name)

Return a provider VDC storage profile by name in the system org.

Returns:ProviderVdcStorageProfile item.
Raises:EntityNotFoundException: if the named provider vdc can not be found.
list_network_pools()

List network pools in the system organization.

Returns:a list of lxml.objectify.ObjectifiedElement containing NetworkPoolReference XML elements.
Return type:list
list_provider_vdc_storage_profiles(name=None)

List provider VDC storage profiles in the system organization.

Returns:a list of ProviderVdcStorageProfile items
Return type:list
list_provider_vdcs()

List provider vdcs in the system organization.

Returns:a list of object containing ProviderVdcReference XML data.
Return type:list