Rest API Reference

来源：互联网发布：3d场景软件编辑：程序博客网时间：2024/05/20 13:37

Rest API Reference

`vnc_cfg_api_server` Package

The main modules in this package are:

vnc_cfg_api_server
gen.resource_common
gen.resource_xsd
vnc_cfg_ifmap
vnc_addr_mgmt
vnc_cfg_types
vnc_cpu_info

`vnc_cfg_api_server` Module

`resource_common` Module

This module defines the classes for every configuration element managed by the system

class vnc_cfg_api_server.gen.resource_common.AccessControlList(name=None, parent_obj=None, access_control_list_entries=None, id_perms=None,**kwargs)

Bases: object

Represents access-control-list configuration representation.

Child of:

VirtualNetwork object OR SecurityGroup object OR

Properties:

access-control-list-entries (AclEntriesType type)
id-perms (IdPermsType type)

Children:

References to:

Referred by:

dump(): Display access-control-list object in compact form.

get_access_control_list_entries(): Get access-control-list-entries for access-control-list.
Returns:AclEntriesType object

get_fq_name(): Return FQN of access-control-list in list form.

get_fq_name_str(): Return FQN of access-control-list as colon delimited string.

get_id_perms(): Get id-perms for access-control-list.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of access-control-list’s parent in list form.

get_parent_fq_name_str(): Return FQN of access-control-list’s parent as colon delimted string.

get_security_group_back_refs(): Return list of all security-groups using this access-control-list

get_type(): Return object type (access-control-list).

get_virtual_network_back_refs(): Return list of all virtual-networks using this access-control-list

set_access_control_list_entries(access_control_list_entries): Set access-control-list-entries for access-control-list.
Parameters:access_control_list_entries – AclEntriesType object

set_id_perms(id_perms): Set id-perms for access-control-list.
Parameters:id_perms – IdPermsType object

class vnc_cfg_api_server.gen.resource_common.BgpRouter(name=None, parent_obj=None, bgp_router_parameters=None, id_perms=None, **kwargs)

Bases: object

Represents bgp-router configuration representation.

Child of:

RoutingInstance object OR

Properties:

bgp-router-parameters (BgpRouterParams type)
id-perms (IdPermsType type)

Children:

References to:

list of (BgpRouter object, BgpPeeringAttributes attribute)

Referred by:

list of GlobalSystemConfig objects
list of PhysicalRouter objects
list of VirtualRouter objects
list of BgpRouter objects

add_bgp_router(ref_obj, ref_data)

Add bgp-router to bgp-router.

Parameters:

ref_obj – BgpRouter object
ref_data – BgpPeeringAttributes object

dump(): Display bgp-router object in compact form.

get_bgp_router_back_refs(): Return list of all bgp-routers using this bgp-router

get_bgp_router_parameters(): Get bgp-router-parameters for bgp-router.
Returns:BgpRouterParams object

get_bgp_router_refs(): Return bgp-router list for bgp-router.
Returns:list of tuple <BgpRouter, BgpPeeringAttributes>

get_fq_name(): Return FQN of bgp-router in list form.

get_fq_name_str(): Return FQN of bgp-router as colon delimited string.

get_global_system_config_back_refs(): Return list of all global-system-configs using this bgp-router

get_id_perms(): Get id-perms for bgp-router.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of bgp-router’s parent in list form.

get_parent_fq_name_str(): Return FQN of bgp-router’s parent as colon delimted string.

get_physical_router_back_refs(): Return list of all physical-routers using this bgp-router

get_routing_instance_back_refs(): Return list of all routing-instances using this bgp-router

get_type(): Return object type (bgp-router).

get_virtual_router_back_refs(): Return list of all virtual-routers using this bgp-router

set_bgp_router(ref_obj, ref_data)

Set bgp-router for bgp-router.

Parameters:

ref_obj – BgpRouter object
ref_data – BgpPeeringAttributes object

set_bgp_router_list(ref_obj_list, ref_data_list)

Set bgp-router list for bgp-router.

Parameters:

ref_obj_list – list of BgpRouter object
ref_data_list – list of BgpPeeringAttributes object

set_bgp_router_parameters(bgp_router_parameters): Set bgp-router-parameters for bgp-router.
Parameters:bgp_router_parameters – BgpRouterParams object

set_id_perms(id_perms): Set id-perms for bgp-router.
Parameters:id_perms – IdPermsType object

class vnc_cfg_api_server.gen.resource_common.ConfigRoot(name=None, id_perms=None, **kwargs)

Bases: object

Represents config-root configuration representation.

Properties:

id-perms (IdPermsType type)

Children:

list of GlobalSystemConfig objects
list of Domain objects

References to:

Referred by:

dump(): Display config-root object in compact form.

get_fq_name(): Return FQN of config-root in list form.

get_fq_name_str(): Return FQN of config-root as colon delimited string.

get_id_perms(): Get id-perms for config-root.
Returns:IdPermsType object

get_type(): Return object type (config-root).

set_id_perms(id_perms): Set id-perms for config-root.
Parameters:id_perms – IdPermsType object

class vnc_cfg_api_server.gen.resource_common.CustomerAttachment(name=None, attachment_address=None, id_perms=None, **kwargs)

Bases: object

Represents customer-attachment configuration representation.

Properties:

attachment-address (AttachmentAddressType type)
id-perms (IdPermsType type)

Children:

References to:

list of VirtualMachineInterface objects
list of FloatingIp objects

Referred by:

add_floating_ip(ref_obj): Add floating-ip to customer-attachment.
Parameters:ref_obj – FloatingIp object

add_virtual_machine_interface(ref_obj): Add virtual-machine-interface to customer-attachment.
Parameters:ref_obj – VirtualMachineInterface object

dump(): Display customer-attachment object in compact form.

get_attachment_address(): Get attachment-address for customer-attachment.
Returns:AttachmentAddressType object

get_floating_ip_refs(): Return floating-ip list for customer-attachment.
Returns:list of <FloatingIp>

get_fq_name(): Return FQN of customer-attachment in list form.

get_fq_name_str(): Return FQN of customer-attachment as colon delimited string.

get_id_perms(): Get id-perms for customer-attachment.
Returns:IdPermsType object

get_type(): Return object type (customer-attachment).

get_virtual_machine_interface_refs(): Return virtual-machine-interface list for customer-attachment.
Returns:list of <VirtualMachineInterface>

set_attachment_address(attachment_address): Set attachment-address for customer-attachment.
Parameters:attachment_address – AttachmentAddressType object

set_floating_ip(ref_obj): Set floating-ip for customer-attachment.
Parameters:ref_obj – FloatingIp object

set_floating_ip_list(ref_obj_list): Set floating-ip list for customer-attachment.
Parameters:ref_obj_list – list of FloatingIp object

set_id_perms(id_perms): Set id-perms for customer-attachment.
Parameters:id_perms – IdPermsType object

set_virtual_machine_interface(ref_obj): Set virtual-machine-interface for customer-attachment.
Parameters:ref_obj – VirtualMachineInterface object

set_virtual_machine_interface_list(ref_obj_list): Set virtual-machine-interface list for customer-attachment.
Parameters:ref_obj_list – list of VirtualMachineInterface object

class vnc_cfg_api_server.gen.resource_common.Domain(name=None, parent_obj=None, domain_limits=None, api_access_list=None, id_perms=None,**kwargs)

Bases: object

Represents domain configuration representation.

Child of:

ConfigRoot object OR

Properties:

domain-limits (DomainLimitsType type)
api-access-list (ApiAccessListType type)
id-perms (IdPermsType type)

Children:

list of Project objects
list of Namespace objects
list of ServiceTemplate objects
list of VirtualDns objects

References to:

Referred by:

dump(): Display domain object in compact form.

get_api_access_list(): Get api-access-list for domain.
Returns:ApiAccessListType object

get_config_root_back_refs(): Return list of all config-roots using this domain

get_domain_limits(): Get domain-limits for domain.
Returns:DomainLimitsType object

get_fq_name(): Return FQN of domain in list form.

get_fq_name_str(): Return FQN of domain as colon delimited string.

get_id_perms(): Get id-perms for domain.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of domain’s parent in list form.

get_parent_fq_name_str(): Return FQN of domain’s parent as colon delimted string.

get_type(): Return object type (domain).

set_api_access_list(api_access_list): Set api-access-list for domain.
Parameters:api_access_list – ApiAccessListType object

set_domain_limits(domain_limits): Set domain-limits for domain.
Parameters:domain_limits – DomainLimitsType object

set_id_perms(id_perms): Set id-perms for domain.
Parameters:id_perms – IdPermsType object

class vnc_cfg_api_server.gen.resource_common.FloatingIp(name=None, parent_obj=None, floating_ip_address=None, floating_ip_is_virtual_ip=None,id_perms=None, **kwargs)

Bases: object

Represents floating-ip configuration representation.

Child of:

FloatingIpPool object OR

Properties:

floating-ip-address (IpAddressType type)
floating-ip-is-virtual-ip (xsd:boolean type)
id-perms (IdPermsType type)

Children:

References to:

list of Project objects
list of VirtualMachineInterface objects

Referred by:

list of CustomerAttachment objects

add_project(ref_obj): Add project to floating-ip.
Parameters:ref_obj – Project object

add_virtual_machine_interface(ref_obj): Add virtual-machine-interface to floating-ip.
Parameters:ref_obj – VirtualMachineInterface object

dump(): Display floating-ip object in compact form.

get_customer_attachment_back_refs(): Return list of all customer-attachments using this floating-ip

get_floating_ip_address(): Get floating-ip-address for floating-ip.
Returns:IpAddressType object

get_floating_ip_is_virtual_ip(): Get floating-ip-is-virtual-ip for floating-ip.
Returns:xsd:boolean object

get_floating_ip_pool_back_refs(): Return list of all floating-ip-pools using this floating-ip

get_fq_name(): Return FQN of floating-ip in list form.

get_fq_name_str(): Return FQN of floating-ip as colon delimited string.

get_id_perms(): Get id-perms for floating-ip.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of floating-ip’s parent in list form.

get_parent_fq_name_str(): Return FQN of floating-ip’s parent as colon delimted string.

get_project_refs(): Return project list for floating-ip.
Returns:list of <Project>

get_type(): Return object type (floating-ip).

get_virtual_machine_interface_refs(): Return virtual-machine-interface list for floating-ip.
Returns:list of <VirtualMachineInterface>

set_floating_ip_address(floating_ip_address): Set floating-ip-address for floating-ip.
Parameters:floating_ip_address – IpAddressType object

set_floating_ip_is_virtual_ip(floating_ip_is_virtual_ip): Set floating-ip-is-virtual-ip for floating-ip.
Parameters:floating_ip_is_virtual_ip – xsd:boolean object

set_id_perms(id_perms): Set id-perms for floating-ip.
Parameters:id_perms – IdPermsType object

set_project(ref_obj): Set project for floating-ip.
Parameters:ref_obj – Project object

set_project_list(ref_obj_list): Set project list for floating-ip.
Parameters:ref_obj_list – list of Project object

set_virtual_machine_interface(ref_obj): Set virtual-machine-interface for floating-ip.
Parameters:ref_obj – VirtualMachineInterface object

set_virtual_machine_interface_list(ref_obj_list): Set virtual-machine-interface list for floating-ip.
Parameters:ref_obj_list – list of VirtualMachineInterface object

class vnc_cfg_api_server.gen.resource_common.FloatingIpPool(name=None, parent_obj=None, floating_ip_pool_prefixes=None, id_perms=None,**kwargs)

Bases: object

Represents floating-ip-pool configuration representation.

Child of:

VirtualNetwork object OR

Properties:

floating-ip-pool-prefixes (FloatingIpPoolType type)
id-perms (IdPermsType type)

Children:

list of FloatingIp objects

References to:

Referred by:

list of Project objects

dump(): Display floating-ip-pool object in compact form.

get_floating_ip_pool_prefixes(): Get floating-ip-pool-prefixes for floating-ip-pool.
Returns:FloatingIpPoolType object

get_fq_name(): Return FQN of floating-ip-pool in list form.

get_fq_name_str(): Return FQN of floating-ip-pool as colon delimited string.

get_id_perms(): Get id-perms for floating-ip-pool.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of floating-ip-pool’s parent in list form.

get_parent_fq_name_str(): Return FQN of floating-ip-pool’s parent as colon delimted string.

get_project_back_refs(): Return list of all projects using this floating-ip-pool

get_type(): Return object type (floating-ip-pool).

get_virtual_network_back_refs(): Return list of all virtual-networks using this floating-ip-pool

set_floating_ip_pool_prefixes(floating_ip_pool_prefixes): Set floating-ip-pool-prefixes for floating-ip-pool.
Parameters:floating_ip_pool_prefixes – FloatingIpPoolType object

set_id_perms(id_perms): Set id-perms for floating-ip-pool.
Parameters:id_perms – IdPermsType object

class vnc_cfg_api_server.gen.resource_common.GlobalSystemConfig(name=None, parent_obj=None, autonomous_system=None, config_version=None,id_perms=None, **kwargs)

Bases: object

Represents global-system-config configuration representation.

Child of:

ConfigRoot object OR

Properties:

autonomous-system (AutonomousSystemType type)
config-version (xsd:string type)
id-perms (IdPermsType type)

Children:

list of GlobalVrouterConfig objects
list of PhysicalRouter objects
list of VirtualRouter objects

References to:

list of BgpRouter objects

Referred by:

add_bgp_router(ref_obj): Add bgp-router to global-system-config.
Parameters:ref_obj – BgpRouter object

dump(): Display global-system-config object in compact form.

get_autonomous_system(): Get autonomous-system for global-system-config.
Returns:AutonomousSystemType object

get_bgp_router_refs(): Return bgp-router list for global-system-config.
Returns:list of <BgpRouter>

get_config_root_back_refs(): Return list of all config-roots using this global-system-config

get_config_version(): Get config-version for global-system-config.
Returns:xsd:string object

get_fq_name(): Return FQN of global-system-config in list form.

get_fq_name_str(): Return FQN of global-system-config as colon delimited string.

get_id_perms(): Get id-perms for global-system-config.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of global-system-config’s parent in list form.

get_parent_fq_name_str(): Return FQN of global-system-config’s parent as colon delimted string.

get_type(): Return object type (global-system-config).

set_autonomous_system(autonomous_system): Set autonomous-system for global-system-config.
Parameters:autonomous_system – AutonomousSystemType object

set_bgp_router(ref_obj): Set bgp-router for global-system-config.
Parameters:ref_obj – BgpRouter object

set_bgp_router_list(ref_obj_list): Set bgp-router list for global-system-config.
Parameters:ref_obj_list – list of BgpRouter object

set_config_version(config_version): Set config-version for global-system-config.
Parameters:config_version – xsd:string object

set_id_perms(id_perms): Set id-perms for global-system-config.
Parameters:id_perms – IdPermsType object

class vnc_cfg_api_server.gen.resource_common.GlobalVrouterConfig(name=None, parent_obj=None, linklocal_services=None,encapsulation_priorities=None, id_perms=None, **kwargs)

Bases: object

Represents global-vrouter-config configuration representation.

Child of:

GlobalSystemConfig object OR

Properties:

linklocal-services (LinklocalServicesTypes type)
encapsulation-priorities (EncapsulationPrioritiesType type)
id-perms (IdPermsType type)

Children:

References to:

Referred by:

dump(): Display global-vrouter-config object in compact form.

get_encapsulation_priorities(): Get encapsulation-priorities for global-vrouter-config.
Returns:EncapsulationPrioritiesType object

get_fq_name(): Return FQN of global-vrouter-config in list form.

get_fq_name_str(): Return FQN of global-vrouter-config as colon delimited string.

get_global_system_config_back_refs(): Return list of all global-system-configs using this global-vrouter-config

get_id_perms(): Get id-perms for global-vrouter-config.
Returns:IdPermsType object

get_linklocal_services(): Get linklocal-services for global-vrouter-config.
Returns:LinklocalServicesTypes object

get_parent_fq_name(): Return FQN of global-vrouter-config’s parent in list form.

get_parent_fq_name_str(): Return FQN of global-vrouter-config’s parent as colon delimted string.

get_type(): Return object type (global-vrouter-config).

set_encapsulation_priorities(encapsulation_priorities): Set encapsulation-priorities for global-vrouter-config.
Parameters:encapsulation_priorities – EncapsulationPrioritiesType object

set_id_perms(id_perms): Set id-perms for global-vrouter-config.
Parameters:id_perms – IdPermsType object

set_linklocal_services(linklocal_services): Set linklocal-services for global-vrouter-config.
Parameters:linklocal_services – LinklocalServicesTypes object

class vnc_cfg_api_server.gen.resource_common.InstanceIp(name=None, instance_ip_address=None, id_perms=None, **kwargs)

Bases: object

Represents instance-ip configuration representation.

Properties:

instance-ip-address (IpAddressType type)
id-perms (IdPermsType type)

Children:

References to:

list of VirtualNetwork objects
list of VirtualMachineInterface objects

Referred by:

add_virtual_machine_interface(ref_obj): Add virtual-machine-interface to instance-ip.
Parameters:ref_obj – VirtualMachineInterface object

add_virtual_network(ref_obj): Add virtual-network to instance-ip.
Parameters:ref_obj – VirtualNetwork object

dump(): Display instance-ip object in compact form.

get_fq_name(): Return FQN of instance-ip in list form.

get_fq_name_str(): Return FQN of instance-ip as colon delimited string.

get_id_perms(): Get id-perms for instance-ip.
Returns:IdPermsType object

get_instance_ip_address(): Get instance-ip-address for instance-ip.
Returns:IpAddressType object

get_type(): Return object type (instance-ip).

get_virtual_machine_interface_refs(): Return virtual-machine-interface list for instance-ip.
Returns:list of <VirtualMachineInterface>

get_virtual_network_refs(): Return virtual-network list for instance-ip.
Returns:list of <VirtualNetwork>

set_id_perms(id_perms): Set id-perms for instance-ip.
Parameters:id_perms – IdPermsType object

set_instance_ip_address(instance_ip_address): Set instance-ip-address for instance-ip.
Parameters:instance_ip_address – IpAddressType object

set_virtual_machine_interface(ref_obj): Set virtual-machine-interface for instance-ip.
Parameters:ref_obj – VirtualMachineInterface object

set_virtual_machine_interface_list(ref_obj_list): Set virtual-machine-interface list for instance-ip.
Parameters:ref_obj_list – list of VirtualMachineInterface object

set_virtual_network(ref_obj): Set virtual-network for instance-ip.
Parameters:ref_obj – VirtualNetwork object

set_virtual_network_list(ref_obj_list): Set virtual-network list for instance-ip.
Parameters:ref_obj_list – list of VirtualNetwork object

class vnc_cfg_api_server.gen.resource_common.LogicalInterface(name=None, parent_obj=None, id_perms=None, **kwargs)

Bases: object

Represents logical-interface configuration representation.

Child of:

PhysicalInterface object OR

Properties:

id-perms (IdPermsType type)

Children:

References to:

list of VirtualNetwork objects

Referred by:

add_virtual_network(ref_obj): Add virtual-network to logical-interface.
Parameters:ref_obj – VirtualNetwork object

dump(): Display logical-interface object in compact form.

get_fq_name(): Return FQN of logical-interface in list form.

get_fq_name_str(): Return FQN of logical-interface as colon delimited string.

get_id_perms(): Get id-perms for logical-interface.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of logical-interface’s parent in list form.

get_parent_fq_name_str(): Return FQN of logical-interface’s parent as colon delimted string.

get_physical_interface_back_refs(): Return list of all physical-interfaces using this logical-interface

get_type(): Return object type (logical-interface).

get_virtual_network_refs(): Return virtual-network list for logical-interface.
Returns:list of <VirtualNetwork>

set_id_perms(id_perms): Set id-perms for logical-interface.
Parameters:id_perms – IdPermsType object

set_virtual_network(ref_obj): Set virtual-network for logical-interface.
Parameters:ref_obj – VirtualNetwork object

set_virtual_network_list(ref_obj_list): Set virtual-network list for logical-interface.
Parameters:ref_obj_list – list of VirtualNetwork object

class vnc_cfg_api_server.gen.resource_common.Namespace(name=None, parent_obj=None, namespace_cidr=None, id_perms=None, **kwargs)

Bases: object

Represents namespace configuration representation.

Child of:

Domain object OR

Properties:

namespace-cidr (SubnetType type)
id-perms (IdPermsType type)

Children:

References to:

Referred by:

list of Project objects

dump(): Display namespace object in compact form.

get_domain_back_refs(): Return list of all domains using this namespace

get_fq_name(): Return FQN of namespace in list form.

get_fq_name_str(): Return FQN of namespace as colon delimited string.

get_id_perms(): Get id-perms for namespace.
Returns:IdPermsType object

get_namespace_cidr(): Get namespace-cidr for namespace.
Returns:SubnetType object

get_parent_fq_name(): Return FQN of namespace’s parent in list form.

get_parent_fq_name_str(): Return FQN of namespace’s parent as colon delimted string.

get_project_back_refs(): Return list of all projects using this namespace

get_type(): Return object type (namespace).

set_id_perms(id_perms): Set id-perms for namespace.
Parameters:id_perms – IdPermsType object

set_namespace_cidr(namespace_cidr): Set namespace-cidr for namespace.
Parameters:namespace_cidr – SubnetType object

class vnc_cfg_api_server.gen.resource_common.NetworkIpam(name=None, parent_obj=None, network_ipam_mgmt=None, id_perms=None, **kwargs)

Bases: object

Represents network-ipam configuration representation.

Child of:

Project object OR

Properties:

network-ipam-mgmt (IpamType type)
id-perms (IdPermsType type)

Children:

References to:

list of VirtualDns objects

Referred by:

list of VirtualNetwork objects

add_virtual_DNS(ref_obj): Add virtual-DNS to network-ipam.
Parameters:ref_obj – VirtualDns object

dump(): Display network-ipam object in compact form.

get_fq_name(): Return FQN of network-ipam in list form.

get_fq_name_str(): Return FQN of network-ipam as colon delimited string.

get_id_perms(): Get id-perms for network-ipam.
Returns:IdPermsType object

get_network_ipam_mgmt(): Get network-ipam-mgmt for network-ipam.
Returns:IpamType object

get_parent_fq_name(): Return FQN of network-ipam’s parent in list form.

get_parent_fq_name_str(): Return FQN of network-ipam’s parent as colon delimted string.

get_project_back_refs(): Return list of all projects using this network-ipam

get_type(): Return object type (network-ipam).

get_virtual_DNS_refs(): Return virtual-DNS list for network-ipam.
Returns:list of <VirtualDns>

get_virtual_network_back_refs(): Return list of all virtual-networks using this network-ipam

set_id_perms(id_perms): Set id-perms for network-ipam.
Parameters:id_perms – IdPermsType object

set_network_ipam_mgmt(network_ipam_mgmt): Set network-ipam-mgmt for network-ipam.
Parameters:network_ipam_mgmt – IpamType object

set_virtual_DNS(ref_obj): Set virtual-DNS for network-ipam.
Parameters:ref_obj – VirtualDns object

set_virtual_DNS_list(ref_obj_list): Set virtual-DNS list for network-ipam.
Parameters:ref_obj_list – list of VirtualDns object

class vnc_cfg_api_server.gen.resource_common.NetworkPolicy(name=None, parent_obj=None, network_policy_entries=None, id_perms=None, **kwargs)

Bases: object

Represents network-policy configuration representation.

Child of:

Project object OR

Properties:

network-policy-entries (PolicyEntriesType type)
id-perms (IdPermsType type)

Children:

References to:

Referred by:

list of VirtualNetwork objects

dump(): Display network-policy object in compact form.

get_fq_name(): Return FQN of network-policy in list form.

get_fq_name_str(): Return FQN of network-policy as colon delimited string.

get_id_perms(): Get id-perms for network-policy.
Returns:IdPermsType object

get_network_policy_entries(): Get network-policy-entries for network-policy.
Returns:PolicyEntriesType object

get_parent_fq_name(): Return FQN of network-policy’s parent in list form.

get_parent_fq_name_str(): Return FQN of network-policy’s parent as colon delimted string.

get_project_back_refs(): Return list of all projects using this network-policy

get_type(): Return object type (network-policy).

get_virtual_network_back_refs(): Return list of all virtual-networks using this network-policy

set_id_perms(id_perms): Set id-perms for network-policy.
Parameters:id_perms – IdPermsType object

set_network_policy_entries(network_policy_entries): Set network-policy-entries for network-policy.
Parameters:network_policy_entries – PolicyEntriesType object

class vnc_cfg_api_server.gen.resource_common.PhysicalInterface(name=None, parent_obj=None, id_perms=None, **kwargs)

Bases: object

Represents physical-interface configuration representation.

Child of:

PhysicalRouter object OR

Properties:

id-perms (IdPermsType type)

Children:

list of LogicalInterface objects

References to:

Referred by:

dump(): Display physical-interface object in compact form.

get_fq_name(): Return FQN of physical-interface in list form.

get_fq_name_str(): Return FQN of physical-interface as colon delimited string.

get_id_perms(): Get id-perms for physical-interface.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of physical-interface’s parent in list form.

get_parent_fq_name_str(): Return FQN of physical-interface’s parent as colon delimted string.

get_physical_router_back_refs(): Return list of all physical-routers using this physical-interface

get_type(): Return object type (physical-interface).

set_id_perms(id_perms): Set id-perms for physical-interface.
Parameters:id_perms – IdPermsType object

class vnc_cfg_api_server.gen.resource_common.PhysicalRouter(name=None, parent_obj=None, id_perms=None, **kwargs)

Bases: object

Represents physical-router configuration representation.

Child of:

GlobalSystemConfig object OR

Properties:

id-perms (IdPermsType type)

Children:

list of PhysicalInterface objects

References to:

list of BgpRouter objects

Referred by:

add_bgp_router(ref_obj): Add bgp-router to physical-router.
Parameters:ref_obj – BgpRouter object

dump(): Display physical-router object in compact form.

get_bgp_router_refs(): Return bgp-router list for physical-router.
Returns:list of <BgpRouter>

get_fq_name(): Return FQN of physical-router in list form.

get_fq_name_str(): Return FQN of physical-router as colon delimited string.

get_global_system_config_back_refs(): Return list of all global-system-configs using this physical-router

get_id_perms(): Get id-perms for physical-router.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of physical-router’s parent in list form.

get_parent_fq_name_str(): Return FQN of physical-router’s parent as colon delimted string.

get_type(): Return object type (physical-router).

set_bgp_router(ref_obj): Set bgp-router for physical-router.
Parameters:ref_obj – BgpRouter object

set_bgp_router_list(ref_obj_list): Set bgp-router list for physical-router.
Parameters:ref_obj_list – list of BgpRouter object

set_id_perms(id_perms): Set id-perms for physical-router.
Parameters:id_perms – IdPermsType object

class vnc_cfg_api_server.gen.resource_common.Project(name=None, parent_obj=None, id_perms=None, **kwargs)

Bases: object

Represents project configuration representation.

Child of:

Domain object OR

Properties:

id-perms (IdPermsType type)

Children:

list of SecurityGroup objects
list of VirtualNetwork objects
list of NetworkIpam objects
list of NetworkPolicy objects
list of ServiceInstance objects
list of RouteTable objects

References to:

list of (Namespace object, SubnetType attribute)
list of FloatingIpPool objects

Referred by:

list of FloatingIp objects

add_floating_ip_pool(ref_obj): Add floating-ip-pool to project.
Parameters:ref_obj – FloatingIpPool object

add_namespace(ref_obj, ref_data)

Add namespace to project.

Parameters:

ref_obj – Namespace object
ref_data – SubnetType object

dump(): Display project object in compact form.

get_domain_back_refs(): Return list of all domains using this project

get_floating_ip_back_refs(): Return list of all floating-ips using this project

get_floating_ip_pool_refs(): Return floating-ip-pool list for project.
Returns:list of <FloatingIpPool>

get_fq_name(): Return FQN of project in list form.

get_fq_name_str(): Return FQN of project as colon delimited string.

get_id_perms(): Get id-perms for project.
Returns:IdPermsType object

get_namespace_refs(): Return namespace list for project.
Returns:list of tuple <Namespace, SubnetType>

get_parent_fq_name(): Return FQN of project’s parent in list form.

get_parent_fq_name_str(): Return FQN of project’s parent as colon delimted string.

get_type(): Return object type (project).

set_floating_ip_pool(ref_obj): Set floating-ip-pool for project.
Parameters:ref_obj – FloatingIpPool object

set_floating_ip_pool_list(ref_obj_list): Set floating-ip-pool list for project.
Parameters:ref_obj_list – list of FloatingIpPool object

set_id_perms(id_perms): Set id-perms for project.
Parameters:id_perms – IdPermsType object

set_namespace(ref_obj, ref_data)

Set namespace for project.

Parameters:

ref_obj – Namespace object
ref_data – SubnetType object

set_namespace_list(ref_obj_list, ref_data_list)

Set namespace list for project.

Parameters:

ref_obj_list – list of Namespace object
ref_data_list – list of SubnetType object

class vnc_cfg_api_server.gen.resource_common.ProviderAttachment(name=None, id_perms=None, **kwargs)

Bases: object

Represents provider-attachment configuration representation.

Properties:

id-perms (IdPermsType type)

Children:

References to:

list of VirtualRouter objects

Referred by:

add_virtual_router(ref_obj): Add virtual-router to provider-attachment.
Parameters:ref_obj – VirtualRouter object

dump(): Display provider-attachment object in compact form.

get_customer_attachment_back_refs(): Return list of all customer-attachments using this provider-attachment

get_fq_name(): Return FQN of provider-attachment in list form.

get_fq_name_str(): Return FQN of provider-attachment as colon delimited string.

get_id_perms(): Get id-perms for provider-attachment.
Returns:IdPermsType object

get_type(): Return object type (provider-attachment).

get_virtual_router_refs(): Return virtual-router list for provider-attachment.
Returns:list of <VirtualRouter>

set_id_perms(id_perms): Set id-perms for provider-attachment.
Parameters:id_perms – IdPermsType object

set_virtual_router(ref_obj): Set virtual-router for provider-attachment.
Parameters:ref_obj – VirtualRouter object

set_virtual_router_list(ref_obj_list): Set virtual-router list for provider-attachment.
Parameters:ref_obj_list – list of VirtualRouter object

class vnc_cfg_api_server.gen.resource_common.RouteTable(name=None, parent_obj=None, routes=None, id_perms=None, **kwargs)

Bases: object

Represents route-table configuration representation.

Child of:

Project object OR

Properties:

routes (RouteTableType type)
id-perms (IdPermsType type)

Children:

References to:

Referred by:

list of VirtualNetwork objects

dump(): Display route-table object in compact form.

get_fq_name(): Return FQN of route-table in list form.

get_fq_name_str(): Return FQN of route-table as colon delimited string.

get_id_perms(): Get id-perms for route-table.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of route-table’s parent in list form.

get_parent_fq_name_str(): Return FQN of route-table’s parent as colon delimted string.

get_project_back_refs(): Return list of all projects using this route-table

get_routes(): Get routes for route-table.
Returns:RouteTableType object

get_type(): Return object type (route-table).

get_virtual_network_back_refs(): Return list of all virtual-networks using this route-table

set_id_perms(id_perms): Set id-perms for route-table.
Parameters:id_perms – IdPermsType object

set_routes(routes): Set routes for route-table.
Parameters:routes – RouteTableType object

class vnc_cfg_api_server.gen.resource_common.RouteTarget(name=None, id_perms=None, **kwargs)

Bases: object

Represents route-target configuration representation.

Properties:

id-perms (IdPermsType type)

Children:

References to:

Referred by:

list of RoutingInstance objects

dump(): Display route-target object in compact form.

get_fq_name(): Return FQN of route-target in list form.

get_fq_name_str(): Return FQN of route-target as colon delimited string.

get_id_perms(): Get id-perms for route-target.
Returns:IdPermsType object

get_routing_instance_back_refs(): Return list of all routing-instances using this route-target

get_type(): Return object type (route-target).

set_id_perms(id_perms): Set id-perms for route-target.
Parameters:id_perms – IdPermsType object

class vnc_cfg_api_server.gen.resource_common.RoutingInstance(name=None, parent_obj=None, service_chain_information=None,static_route_entries=None, default_ce_protocol=None, id_perms=None, **kwargs)

Bases: object

Represents routing-instance configuration representation.

Child of:

VirtualNetwork object OR

Properties:

service-chain-information (ServiceChainInfo type)
static-route-entries (StaticRouteEntriesType type)
default-ce-protocol (DefaultProtocolType type)
id-perms (IdPermsType type)

Children:

list of BgpRouter objects

References to:

list of (RoutingInstance object, ConnectionType attribute)
list of (RouteTarget object, InstanceTargetType attribute)

Referred by:

list of VirtualMachineInterface objects
list of RoutingInstance objects

add_route_target(ref_obj, ref_data)

Add route-target to routing-instance.

Parameters:

ref_obj – RouteTarget object
ref_data – InstanceTargetType object

add_routing_instance(ref_obj, ref_data)

Add routing-instance to routing-instance.

Parameters:

ref_obj – RoutingInstance object
ref_data – ConnectionType object

dump(): Display routing-instance object in compact form.

get_customer_attachment_back_refs(): Return list of all customer-attachments using this routing-instance

get_default_ce_protocol(): Get default-ce-protocol for routing-instance.
Returns:DefaultProtocolType object

get_fq_name(): Return FQN of routing-instance in list form.

get_fq_name_str(): Return FQN of routing-instance as colon delimited string.

get_id_perms(): Get id-perms for routing-instance.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of routing-instance’s parent in list form.

get_parent_fq_name_str(): Return FQN of routing-instance’s parent as colon delimted string.

get_route_target_refs(): Return route-target list for routing-instance.
Returns:list of tuple <RouteTarget, InstanceTargetType>

get_routing_instance_back_refs(): Return list of all routing-instances using this routing-instance

get_routing_instance_refs(): Return routing-instance list for routing-instance.
Returns:list of tuple <RoutingInstance, ConnectionType>

get_service_chain_information(): Get service-chain-information for routing-instance.
Returns:ServiceChainInfo object

get_static_route_entries(): Get static-route-entries for routing-instance.
Returns:StaticRouteEntriesType object

get_type(): Return object type (routing-instance).

get_virtual_machine_interface_back_refs(): Return list of all virtual-machine-interfaces using this routing-instance

get_virtual_network_back_refs(): Return list of all virtual-networks using this routing-instance

set_default_ce_protocol(default_ce_protocol): Set default-ce-protocol for routing-instance.
Parameters:default_ce_protocol – DefaultProtocolType object

set_id_perms(id_perms): Set id-perms for routing-instance.
Parameters:id_perms – IdPermsType object

set_route_target(ref_obj, ref_data)

Set route-target for routing-instance.

Parameters:

ref_obj – RouteTarget object
ref_data – InstanceTargetType object

set_route_target_list(ref_obj_list, ref_data_list)

Set route-target list for routing-instance.

Parameters:

ref_obj_list – list of RouteTarget object
ref_data_list – list of InstanceTargetType object

set_routing_instance(ref_obj, ref_data)

Set routing-instance for routing-instance.

Parameters:

ref_obj – RoutingInstance object
ref_data – ConnectionType object

set_routing_instance_list(ref_obj_list, ref_data_list)

Set routing-instance list for routing-instance.

Parameters:

ref_obj_list – list of RoutingInstance object
ref_data_list – list of ConnectionType object

set_service_chain_information(service_chain_information): Set service-chain-information for routing-instance.
Parameters:service_chain_information – ServiceChainInfo object

set_static_route_entries(static_route_entries): Set static-route-entries for routing-instance.
Parameters:static_route_entries – StaticRouteEntriesType object

class vnc_cfg_api_server.gen.resource_common.SecurityGroup(name=None, parent_obj=None, security_group_id=None, security_group_entries=None,id_perms=None, **kwargs)

Bases: object

Represents security-group configuration representation.

Child of:

Project object OR

Properties:

security-group-id (xsd:string type)
security-group-entries (PolicyEntriesType type)
id-perms (IdPermsType type)

Children:

list of AccessControlList objects

References to:

Referred by:

list of VirtualMachineInterface objects

dump(): Display security-group object in compact form.

get_fq_name(): Return FQN of security-group in list form.

get_fq_name_str(): Return FQN of security-group as colon delimited string.

get_id_perms(): Get id-perms for security-group.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of security-group’s parent in list form.

get_parent_fq_name_str(): Return FQN of security-group’s parent as colon delimted string.

get_project_back_refs(): Return list of all projects using this security-group

get_security_group_entries(): Get security-group-entries for security-group.
Returns:PolicyEntriesType object

get_security_group_id(): Get security-group-id for security-group.
Returns:xsd:string object

get_type(): Return object type (security-group).

get_virtual_machine_interface_back_refs(): Return list of all virtual-machine-interfaces using this security-group

set_id_perms(id_perms): Set id-perms for security-group.
Parameters:id_perms – IdPermsType object

set_security_group_entries(security_group_entries): Set security-group-entries for security-group.
Parameters:security_group_entries – PolicyEntriesType object

set_security_group_id(security_group_id): Set security-group-id for security-group.
Parameters:security_group_id – xsd:string object

class vnc_cfg_api_server.gen.resource_common.ServiceInstance(name=None, parent_obj=None, service_instance_properties=None, id_perms=None,**kwargs)

Bases: object

Represents service-instance configuration representation.

Child of:

Project object OR

Properties:

service-instance-properties (ServiceInstanceType type)
id-perms (IdPermsType type)

Children:

References to:

list of ServiceTemplate objects

Referred by:

list of VirtualMachine objects

add_service_template(ref_obj): Add service-template to service-instance.
Parameters:ref_obj – ServiceTemplate object

dump(): Display service-instance object in compact form.

get_fq_name(): Return FQN of service-instance in list form.

get_fq_name_str(): Return FQN of service-instance as colon delimited string.

get_id_perms(): Get id-perms for service-instance.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of service-instance’s parent in list form.

get_parent_fq_name_str(): Return FQN of service-instance’s parent as colon delimted string.

get_project_back_refs(): Return list of all projects using this service-instance

get_service_instance_properties(): Get service-instance-properties for service-instance.
Returns:ServiceInstanceType object

get_service_template_refs(): Return service-template list for service-instance.
Returns:list of <ServiceTemplate>

get_type(): Return object type (service-instance).

get_virtual_machine_back_refs(): Return list of all virtual-machines using this service-instance

set_id_perms(id_perms): Set id-perms for service-instance.
Parameters:id_perms – IdPermsType object

set_service_instance_properties(service_instance_properties): Set service-instance-properties for service-instance.
Parameters:service_instance_properties – ServiceInstanceType object

set_service_template(ref_obj): Set service-template for service-instance.
Parameters:ref_obj – ServiceTemplate object

set_service_template_list(ref_obj_list): Set service-template list for service-instance.
Parameters:ref_obj_list – list of ServiceTemplate object

class vnc_cfg_api_server.gen.resource_common.ServiceTemplate(name=None, parent_obj=None, service_template_properties=None, id_perms=None,**kwargs)

Bases: object

Represents service-template configuration representation.

Child of:

Domain object OR

Properties:

service-template-properties (ServiceTemplateType type)
id-perms (IdPermsType type)

Children:

References to:

Referred by:

list of ServiceInstance objects

dump(): Display service-template object in compact form.

get_domain_back_refs(): Return list of all domains using this service-template

get_fq_name(): Return FQN of service-template in list form.

get_fq_name_str(): Return FQN of service-template as colon delimited string.

get_id_perms(): Get id-perms for service-template.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of service-template’s parent in list form.

get_parent_fq_name_str(): Return FQN of service-template’s parent as colon delimted string.

get_service_instance_back_refs(): Return list of all service-instances using this service-template

get_service_template_properties(): Get service-template-properties for service-template.
Returns:ServiceTemplateType object

get_type(): Return object type (service-template).

set_id_perms(id_perms): Set id-perms for service-template.
Parameters:id_perms – IdPermsType object

set_service_template_properties(service_template_properties): Set service-template-properties for service-template.
Parameters:service_template_properties – ServiceTemplateType object

class vnc_cfg_api_server.gen.resource_common.VirtualDns(name=None, parent_obj=None, virtual_DNS_data=None, id_perms=None, **kwargs)

Bases: object

Represents virtual-DNS configuration representation.

Child of:

Domain object OR

Properties:

virtual-DNS-data (VirtualDnsType type)
id-perms (IdPermsType type)

Children:

list of VirtualDnsRecord objects

References to:

Referred by:

list of NetworkIpam objects

dump(): Display virtual-DNS object in compact form.

get_domain_back_refs(): Return list of all domains using this virtual-DNS

get_fq_name(): Return FQN of virtual-DNS in list form.

get_fq_name_str(): Return FQN of virtual-DNS as colon delimited string.

get_id_perms(): Get id-perms for virtual-DNS.
Returns:IdPermsType object

get_network_ipam_back_refs(): Return list of all network-ipams using this virtual-DNS

get_parent_fq_name(): Return FQN of virtual-DNS’s parent in list form.

get_parent_fq_name_str(): Return FQN of virtual-DNS’s parent as colon delimted string.

get_type(): Return object type (virtual-DNS).

get_virtual_DNS_data(): Get virtual-DNS-data for virtual-DNS.
Returns:VirtualDnsType object

set_id_perms(id_perms): Set id-perms for virtual-DNS.
Parameters:id_perms – IdPermsType object

set_virtual_DNS_data(virtual_DNS_data): Set virtual-DNS-data for virtual-DNS.
Parameters:virtual_DNS_data – VirtualDnsType object

class vnc_cfg_api_server.gen.resource_common.VirtualDnsRecord(name=None, parent_obj=None, virtual_DNS_record_data=None, id_perms=None,**kwargs)

Bases: object

Represents virtual-DNS-record configuration representation.

Child of:

VirtualDns object OR

Properties:

virtual-DNS-record-data (VirtualDnsRecordType type)
id-perms (IdPermsType type)

Children:

References to:

Referred by:

dump(): Display virtual-DNS-record object in compact form.

get_fq_name(): Return FQN of virtual-DNS-record in list form.

get_fq_name_str(): Return FQN of virtual-DNS-record as colon delimited string.

get_id_perms(): Get id-perms for virtual-DNS-record.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of virtual-DNS-record’s parent in list form.

get_parent_fq_name_str(): Return FQN of virtual-DNS-record’s parent as colon delimted string.

get_type(): Return object type (virtual-DNS-record).

get_virtual_DNS_back_refs(): Return list of all virtual-DNSs using this virtual-DNS-record

get_virtual_DNS_record_data(): Get virtual-DNS-record-data for virtual-DNS-record.
Returns:VirtualDnsRecordType object

set_id_perms(id_perms): Set id-perms for virtual-DNS-record.
Parameters:id_perms – IdPermsType object

set_virtual_DNS_record_data(virtual_DNS_record_data): Set virtual-DNS-record-data for virtual-DNS-record.
Parameters:virtual_DNS_record_data – VirtualDnsRecordType object

class vnc_cfg_api_server.gen.resource_common.VirtualMachine(name=None, id_perms=None, **kwargs)

Bases: object

Represents virtual-machine configuration representation.

Properties:

id-perms (IdPermsType type)

Children:

list of VirtualMachineInterface objects

References to:

list of ServiceInstance objects

Referred by:

list of VirtualRouter objects

add_service_instance(ref_obj): Add service-instance to virtual-machine.
Parameters:ref_obj – ServiceInstance object

dump(): Display virtual-machine object in compact form.

get_fq_name(): Return FQN of virtual-machine in list form.

get_fq_name_str(): Return FQN of virtual-machine as colon delimited string.

get_id_perms(): Get id-perms for virtual-machine.
Returns:IdPermsType object

get_service_instance_refs(): Return service-instance list for virtual-machine.
Returns:list of <ServiceInstance>

get_type(): Return object type (virtual-machine).

get_virtual_router_back_refs(): Return list of all virtual-routers using this virtual-machine

set_id_perms(id_perms): Set id-perms for virtual-machine.
Parameters:id_perms – IdPermsType object

set_service_instance(ref_obj): Set service-instance for virtual-machine.
Parameters:ref_obj – ServiceInstance object

set_service_instance_list(ref_obj_list): Set service-instance list for virtual-machine.
Parameters:ref_obj_list – list of ServiceInstance object

class vnc_cfg_api_server.gen.resource_common.VirtualMachineInterface(name=None, parent_obj=None,virtual_machine_interface_mac_addresses=None, virtual_machine_interface_properties=None, id_perms=None, **kwargs)

Bases: object

Represents virtual-machine-interface configuration representation.

Child of:

VirtualMachine object OR

Properties:

virtual-machine-interface-mac-addresses (MacAddressesType type)
virtual-machine-interface-properties (VirtualMachineInterfacePropertiesType type)
id-perms (IdPermsType type)

Children:

References to:

list of SecurityGroup objects
list of VirtualNetwork objects
list of (RoutingInstance object, PolicyBasedForwardingRuleType attribute)

Referred by:

list of InstanceIp objects
list of FloatingIp objects
list of CustomerAttachment objects

add_routing_instance(ref_obj, ref_data)

Add routing-instance to virtual-machine-interface.

Parameters:

ref_obj – RoutingInstance object
ref_data – PolicyBasedForwardingRuleType object

add_security_group(ref_obj): Add security-group to virtual-machine-interface.
Parameters:ref_obj – SecurityGroup object

add_virtual_network(ref_obj): Add virtual-network to virtual-machine-interface.
Parameters:ref_obj – VirtualNetwork object

dump(): Display virtual-machine-interface object in compact form.

get_customer_attachment_back_refs(): Return list of all customer-attachments using this virtual-machine-interface

get_floating_ip_back_refs(): Return list of all floating-ips using this virtual-machine-interface

get_fq_name(): Return FQN of virtual-machine-interface in list form.

get_fq_name_str(): Return FQN of virtual-machine-interface as colon delimited string.

get_id_perms(): Get id-perms for virtual-machine-interface.
Returns:IdPermsType object

get_instance_ip_back_refs(): Return list of all instance-ips using this virtual-machine-interface

get_parent_fq_name(): Return FQN of virtual-machine-interface’s parent in list form.

get_parent_fq_name_str(): Return FQN of virtual-machine-interface’s parent as colon delimted string.

get_routing_instance_refs(): Return routing-instance list for virtual-machine-interface.
Returns:list of tuple <RoutingInstance, PolicyBasedForwardingRuleType>

get_security_group_refs(): Return security-group list for virtual-machine-interface.
Returns:list of <SecurityGroup>

get_type(): Return object type (virtual-machine-interface).

get_virtual_machine_back_refs(): Return list of all virtual-machines using this virtual-machine-interface

get_virtual_machine_interface_mac_addresses(): Get virtual-machine-interface-mac-addresses for virtual-machine-interface.
Returns:MacAddressesType object

get_virtual_machine_interface_properties(): Get virtual-machine-interface-properties for virtual-machine-interface.
Returns:VirtualMachineInterfacePropertiesType object

get_virtual_network_refs(): Return virtual-network list for virtual-machine-interface.
Returns:list of <VirtualNetwork>

set_id_perms(id_perms): Set id-perms for virtual-machine-interface.
Parameters:id_perms – IdPermsType object

set_routing_instance(ref_obj, ref_data)

Set routing-instance for virtual-machine-interface.

Parameters:

ref_obj – RoutingInstance object
ref_data – PolicyBasedForwardingRuleType object

set_routing_instance_list(ref_obj_list, ref_data_list)

Set routing-instance list for virtual-machine-interface.

Parameters:

ref_obj_list – list of RoutingInstance object
ref_data_list – list of PolicyBasedForwardingRuleType object

set_security_group(ref_obj): Set security-group for virtual-machine-interface.
Parameters:ref_obj – SecurityGroup object

set_security_group_list(ref_obj_list): Set security-group list for virtual-machine-interface.
Parameters:ref_obj_list – list of SecurityGroup object

set_virtual_machine_interface_mac_addresses(virtual_machine_interface_mac_addresses): Set virtual-machine-interface-mac-addresses for virtual-machine-interface.
Parameters:virtual_machine_interface_mac_addresses – MacAddressesType object

set_virtual_machine_interface_properties(virtual_machine_interface_properties): Set virtual-machine-interface-properties for virtual-machine-interface.
Parameters:virtual_machine_interface_properties – VirtualMachineInterfacePropertiesType object

set_virtual_network(ref_obj): Set virtual-network for virtual-machine-interface.
Parameters:ref_obj – VirtualNetwork object

set_virtual_network_list(ref_obj_list): Set virtual-network list for virtual-machine-interface.
Parameters:ref_obj_list – list of VirtualNetwork object

class vnc_cfg_api_server.gen.resource_common.VirtualNetwork(name=None, parent_obj=None, virtual_network_properties=None,route_target_list=None, id_perms=None, **kwargs)

Bases: object

Represents virtual-network configuration representation.

Child of:

Project object OR

Properties:

virtual-network-properties (VirtualNetworkType type)
route-target-list (RouteTargetList type)
id-perms (IdPermsType type)

Children:

list of AccessControlList objects
list of FloatingIpPool objects
list of RoutingInstance objects

References to:

list of (NetworkIpam object, VnSubnetsType attribute)
list of (NetworkPolicy object, VirtualNetworkPolicyType attribute)
list of RouteTable objects

Referred by:

list of VirtualMachineInterface objects
list of InstanceIp objects
list of LogicalInterface objects

add_network_ipam(ref_obj, ref_data)

Add network-ipam to virtual-network.

Parameters:

ref_obj – NetworkIpam object
ref_data – VnSubnetsType object

add_network_policy(ref_obj, ref_data)

Add network-policy to virtual-network.

Parameters:

ref_obj – NetworkPolicy object
ref_data – VirtualNetworkPolicyType object

add_route_table(ref_obj): Add route-table to virtual-network.
Parameters:ref_obj – RouteTable object

dump(): Display virtual-network object in compact form.

get_fq_name(): Return FQN of virtual-network in list form.

get_fq_name_str(): Return FQN of virtual-network as colon delimited string.

get_id_perms(): Get id-perms for virtual-network.
Returns:IdPermsType object

get_instance_ip_back_refs(): Return list of all instance-ips using this virtual-network

get_logical_interface_back_refs(): Return list of all logical-interfaces using this virtual-network

get_network_ipam_refs(): Return network-ipam list for virtual-network.
Returns:list of tuple <NetworkIpam, VnSubnetsType>

get_network_policy_refs(): Return network-policy list for virtual-network.
Returns:list of tuple <NetworkPolicy, VirtualNetworkPolicyType>

get_parent_fq_name(): Return FQN of virtual-network’s parent in list form.

get_parent_fq_name_str(): Return FQN of virtual-network’s parent as colon delimted string.

get_project_back_refs(): Return list of all projects using this virtual-network

get_route_table_refs(): Return route-table list for virtual-network.
Returns:list of <RouteTable>

get_route_target_list(): Get route-target-list for virtual-network.
Returns:RouteTargetList object

get_type(): Return object type (virtual-network).

get_virtual_machine_interface_back_refs(): Return list of all virtual-machine-interfaces using this virtual-network

get_virtual_network_properties(): Get virtual-network-properties for virtual-network.
Returns:VirtualNetworkType object

set_id_perms(id_perms): Set id-perms for virtual-network.
Parameters:id_perms – IdPermsType object

set_network_ipam(ref_obj, ref_data)

Set network-ipam for virtual-network.

Parameters:

ref_obj – NetworkIpam object
ref_data – VnSubnetsType object

set_network_ipam_list(ref_obj_list, ref_data_list)

Set network-ipam list for virtual-network.

Parameters:

ref_obj_list – list of NetworkIpam object
ref_data_list – list of VnSubnetsType object

set_network_policy(ref_obj, ref_data)

Set network-policy for virtual-network.

Parameters:

ref_obj – NetworkPolicy object
ref_data – VirtualNetworkPolicyType object

set_network_policy_list(ref_obj_list, ref_data_list)

Set network-policy list for virtual-network.

Parameters:

ref_obj_list – list of NetworkPolicy object
ref_data_list – list of VirtualNetworkPolicyType object

set_route_table(ref_obj): Set route-table for virtual-network.
Parameters:ref_obj – RouteTable object

set_route_table_list(ref_obj_list): Set route-table list for virtual-network.
Parameters:ref_obj_list – list of RouteTable object

set_route_target_list(route_target_list): Set route-target-list for virtual-network.
Parameters:route_target_list – RouteTargetList object

set_virtual_network_properties(virtual_network_properties): Set virtual-network-properties for virtual-network.
Parameters:virtual_network_properties – VirtualNetworkType object

class vnc_cfg_api_server.gen.resource_common.VirtualRouter(name=None, parent_obj=None, virtual_router_ip_address=None, id_perms=None,**kwargs)

Bases: object

Represents virtual-router configuration representation.

Child of:

GlobalSystemConfig object OR

Properties:

virtual-router-ip-address (IpAddressType type)
id-perms (IdPermsType type)

Children:

References to:

list of BgpRouter objects
list of VirtualMachine objects

Referred by:

list of ProviderAttachment objects

add_bgp_router(ref_obj): Add bgp-router to virtual-router.
Parameters:ref_obj – BgpRouter object

add_virtual_machine(ref_obj): Add virtual-machine to virtual-router.
Parameters:ref_obj – VirtualMachine object

dump(): Display virtual-router object in compact form.

get_bgp_router_refs(): Return bgp-router list for virtual-router.
Returns:list of <BgpRouter>

get_fq_name(): Return FQN of virtual-router in list form.

get_fq_name_str(): Return FQN of virtual-router as colon delimited string.

get_global_system_config_back_refs(): Return list of all global-system-configs using this virtual-router

get_id_perms(): Get id-perms for virtual-router.
Returns:IdPermsType object

get_parent_fq_name(): Return FQN of virtual-router’s parent in list form.

get_parent_fq_name_str(): Return FQN of virtual-router’s parent as colon delimted string.

get_provider_attachment_back_refs(): Return list of all provider-attachments using this virtual-router

get_type(): Return object type (virtual-router).

get_virtual_machine_refs(): Return virtual-machine list for virtual-router.
Returns:list of <VirtualMachine>

get_virtual_router_ip_address(): Get virtual-router-ip-address for virtual-router.
Returns:IpAddressType object

set_bgp_router(ref_obj): Set bgp-router for virtual-router.
Parameters:ref_obj – BgpRouter object

set_bgp_router_list(ref_obj_list): Set bgp-router list for virtual-router.
Parameters:ref_obj_list – list of BgpRouter object

set_id_perms(id_perms): Set id-perms for virtual-router.
Parameters:id_perms – IdPermsType object

set_virtual_machine(ref_obj): Set virtual-machine for virtual-router.
Parameters:ref_obj – VirtualMachine object

set_virtual_machine_list(ref_obj_list): Set virtual-machine list for virtual-router.
Parameters:ref_obj_list – list of VirtualMachine object

set_virtual_router_ip_address(virtual_router_ip_address): Set virtual-router-ip-address for virtual-router.
Parameters:virtual_router_ip_address – IpAddressType object

`resource_xsd` Module

This module defines the classes for types defined in vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.AclEntriesType(dynamic=None, acl_rule=None, **kwargs)