gen Package

cfixture Module

connection_drv_gen Module

class vnc_cfg_api_server.gen.connection_drv_gen.ConnectionDriverBase

Bases: object

This class provides type specific methods to create, read, update, delete and list objects from the server

access_control_list_create(obj)

Create new access-control-list.

Parameters:objAccessControlList object
access_control_list_delete(fq_name=None, id=None, ifmap_id=None)

Delete access-control-list from the system.

Parameters:
  • fq_name – Fully qualified name of access-control-list
  • id – UUID of access-control-list
  • ifmap_id – IFMAP id of access-control-list
access_control_list_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return access-control-list information.

Parameters:
  • fq_name – Fully qualified name of access-control-list
  • fq_name_str – Fully qualified name string of access-control-list
  • id – UUID of access-control-list
  • ifmap_id – IFMAP id of access-control-list
Returns:

AccessControlList object

access_control_list_update(obj)

Update access-control-list.

Parameters:objAccessControlList object
access_control_lists_list(parent_id=None, parent_fq_name=None)

List all access-control-lists.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of AccessControlList objects

bgp_router_create(obj)

Create new bgp-router.

Parameters:objBgpRouter object
bgp_router_delete(fq_name=None, id=None, ifmap_id=None)

Delete bgp-router from the system.

Parameters:
  • fq_name – Fully qualified name of bgp-router
  • id – UUID of bgp-router
  • ifmap_id – IFMAP id of bgp-router
bgp_router_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return bgp-router information.

Parameters:
  • fq_name – Fully qualified name of bgp-router
  • fq_name_str – Fully qualified name string of bgp-router
  • id – UUID of bgp-router
  • ifmap_id – IFMAP id of bgp-router
Returns:

BgpRouter object

bgp_router_update(obj)

Update bgp-router.

Parameters:objBgpRouter object
bgp_routers_list(parent_id=None, parent_fq_name=None)

List all bgp-routers.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of BgpRouter objects

config_root_create(obj)

Create new config-root.

Parameters:objConfigRoot object
config_root_delete(fq_name=None, id=None, ifmap_id=None)

Delete config-root from the system.

Parameters:
  • fq_name – Fully qualified name of config-root
  • id – UUID of config-root
  • ifmap_id – IFMAP id of config-root
config_root_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return config-root information.

Parameters:
  • fq_name – Fully qualified name of config-root
  • fq_name_str – Fully qualified name string of config-root
  • id – UUID of config-root
  • ifmap_id – IFMAP id of config-root
Returns:

ConfigRoot object

config_root_update(obj)

Update config-root.

Parameters:objConfigRoot object
config_roots_list()

List all config-roots.

customer_attachment_create(obj)

Create new customer-attachment.

Parameters:objCustomerAttachment object
customer_attachment_delete(fq_name=None, id=None, ifmap_id=None)

Delete customer-attachment from the system.

Parameters:
  • fq_name – Fully qualified name of customer-attachment
  • id – UUID of customer-attachment
  • ifmap_id – IFMAP id of customer-attachment
customer_attachment_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return customer-attachment information.

Parameters:
  • fq_name – Fully qualified name of customer-attachment
  • fq_name_str – Fully qualified name string of customer-attachment
  • id – UUID of customer-attachment
  • ifmap_id – IFMAP id of customer-attachment
Returns:

CustomerAttachment object

customer_attachment_update(obj)

Update customer-attachment.

Parameters:objCustomerAttachment object
customer_attachments_list()

List all customer-attachments.

domain_create(obj)

Create new domain.

Parameters:objDomain object
domain_delete(fq_name=None, id=None, ifmap_id=None)

Delete domain from the system.

Parameters:
  • fq_name – Fully qualified name of domain
  • id – UUID of domain
  • ifmap_id – IFMAP id of domain
domain_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return domain information.

Parameters:
  • fq_name – Fully qualified name of domain
  • fq_name_str – Fully qualified name string of domain
  • id – UUID of domain
  • ifmap_id – IFMAP id of domain
Returns:

Domain object

domain_update(obj)

Update domain.

Parameters:objDomain object
domains_list(parent_id=None, parent_fq_name=None)

List all domains.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of Domain objects

floating_ip_create(obj)

Create new floating-ip.

Parameters:objFloatingIp object
floating_ip_delete(fq_name=None, id=None, ifmap_id=None)

Delete floating-ip from the system.

Parameters:
  • fq_name – Fully qualified name of floating-ip
  • id – UUID of floating-ip
  • ifmap_id – IFMAP id of floating-ip
floating_ip_pool_create(obj)

Create new floating-ip-pool.

Parameters:objFloatingIpPool object
floating_ip_pool_delete(fq_name=None, id=None, ifmap_id=None)

Delete floating-ip-pool from the system.

Parameters:
  • fq_name – Fully qualified name of floating-ip-pool
  • id – UUID of floating-ip-pool
  • ifmap_id – IFMAP id of floating-ip-pool
floating_ip_pool_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return floating-ip-pool information.

Parameters:
  • fq_name – Fully qualified name of floating-ip-pool
  • fq_name_str – Fully qualified name string of floating-ip-pool
  • id – UUID of floating-ip-pool
  • ifmap_id – IFMAP id of floating-ip-pool
Returns:

FloatingIpPool object

floating_ip_pool_update(obj)

Update floating-ip-pool.

Parameters:objFloatingIpPool object
floating_ip_pools_list(parent_id=None, parent_fq_name=None)

List all floating-ip-pools.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of FloatingIpPool objects

floating_ip_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return floating-ip information.

Parameters:
  • fq_name – Fully qualified name of floating-ip
  • fq_name_str – Fully qualified name string of floating-ip
  • id – UUID of floating-ip
  • ifmap_id – IFMAP id of floating-ip
Returns:

FloatingIp object

floating_ip_update(obj)

Update floating-ip.

Parameters:objFloatingIp object
floating_ips_list(parent_id=None, parent_fq_name=None)

List all floating-ips.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of FloatingIp objects

get_default_access_control_list_id()

Return UUID of default access-control-list.

get_default_bgp_router_id()

Return UUID of default bgp-router.

get_default_config_root_id()

Return UUID of default config-root.

get_default_customer_attachment_id()

Return UUID of default customer-attachment.

get_default_domain_id()

Return UUID of default domain.

get_default_floating_ip_id()

Return UUID of default floating-ip.

get_default_floating_ip_pool_id()

Return UUID of default floating-ip-pool.

get_default_global_system_config_id()

Return UUID of default global-system-config.

get_default_global_vrouter_config_id()

Return UUID of default global-vrouter-config.

get_default_instance_ip_id()

Return UUID of default instance-ip.

get_default_logical_interface_id()

Return UUID of default logical-interface.

get_default_namespace_id()

Return UUID of default namespace.

get_default_network_ipam_id()

Return UUID of default network-ipam.

get_default_network_policy_id()

Return UUID of default network-policy.

get_default_physical_interface_id()

Return UUID of default physical-interface.

get_default_physical_router_id()

Return UUID of default physical-router.

get_default_project_id()

Return UUID of default project.

get_default_provider_attachment_id()

Return UUID of default provider-attachment.

get_default_route_table_id()

Return UUID of default route-table.

get_default_route_target_id()

Return UUID of default route-target.

get_default_routing_instance_id()

Return UUID of default routing-instance.

get_default_security_group_id()

Return UUID of default security-group.

get_default_service_instance_id()

Return UUID of default service-instance.

get_default_service_template_id()

Return UUID of default service-template.

get_default_virtual_DNS_id()

Return UUID of default virtual-DNS.

get_default_virtual_DNS_record_id()

Return UUID of default virtual-DNS-record.

get_default_virtual_machine_id()

Return UUID of default virtual-machine.

get_default_virtual_machine_interface_id()

Return UUID of default virtual-machine-interface.

get_default_virtual_network_id()

Return UUID of default virtual-network.

get_default_virtual_router_id()

Return UUID of default virtual-router.

global_system_config_create(obj)

Create new global-system-config.

Parameters:objGlobalSystemConfig object
global_system_config_delete(fq_name=None, id=None, ifmap_id=None)

Delete global-system-config from the system.

Parameters:
  • fq_name – Fully qualified name of global-system-config
  • id – UUID of global-system-config
  • ifmap_id – IFMAP id of global-system-config
global_system_config_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return global-system-config information.

Parameters:
  • fq_name – Fully qualified name of global-system-config
  • fq_name_str – Fully qualified name string of global-system-config
  • id – UUID of global-system-config
  • ifmap_id – IFMAP id of global-system-config
Returns:

GlobalSystemConfig object

global_system_config_update(obj)

Update global-system-config.

Parameters:objGlobalSystemConfig object
global_system_configs_list(parent_id=None, parent_fq_name=None)

List all global-system-configs.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of GlobalSystemConfig objects

global_vrouter_config_create(obj)

Create new global-vrouter-config.

Parameters:objGlobalVrouterConfig object
global_vrouter_config_delete(fq_name=None, id=None, ifmap_id=None)

Delete global-vrouter-config from the system.

Parameters:
  • fq_name – Fully qualified name of global-vrouter-config
  • id – UUID of global-vrouter-config
  • ifmap_id – IFMAP id of global-vrouter-config
global_vrouter_config_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return global-vrouter-config information.

Parameters:
  • fq_name – Fully qualified name of global-vrouter-config
  • fq_name_str – Fully qualified name string of global-vrouter-config
  • id – UUID of global-vrouter-config
  • ifmap_id – IFMAP id of global-vrouter-config
Returns:

GlobalVrouterConfig object

global_vrouter_config_update(obj)

Update global-vrouter-config.

Parameters:objGlobalVrouterConfig object
global_vrouter_configs_list(parent_id=None, parent_fq_name=None)

List all global-vrouter-configs.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of GlobalVrouterConfig objects

instance_ip_create(obj)

Create new instance-ip.

Parameters:objInstanceIp object
instance_ip_delete(fq_name=None, id=None, ifmap_id=None)

Delete instance-ip from the system.

Parameters:
  • fq_name – Fully qualified name of instance-ip
  • id – UUID of instance-ip
  • ifmap_id – IFMAP id of instance-ip
instance_ip_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return instance-ip information.

Parameters:
  • fq_name – Fully qualified name of instance-ip
  • fq_name_str – Fully qualified name string of instance-ip
  • id – UUID of instance-ip
  • ifmap_id – IFMAP id of instance-ip
Returns:

InstanceIp object

instance_ip_update(obj)

Update instance-ip.

Parameters:objInstanceIp object
instance_ips_list()

List all instance-ips.

logical_interface_create(obj)

Create new logical-interface.

Parameters:objLogicalInterface object
logical_interface_delete(fq_name=None, id=None, ifmap_id=None)

Delete logical-interface from the system.

Parameters:
  • fq_name – Fully qualified name of logical-interface
  • id – UUID of logical-interface
  • ifmap_id – IFMAP id of logical-interface
logical_interface_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return logical-interface information.

Parameters:
  • fq_name – Fully qualified name of logical-interface
  • fq_name_str – Fully qualified name string of logical-interface
  • id – UUID of logical-interface
  • ifmap_id – IFMAP id of logical-interface
Returns:

LogicalInterface object

logical_interface_update(obj)

Update logical-interface.

Parameters:objLogicalInterface object
logical_interfaces_list(parent_id=None, parent_fq_name=None)

List all logical-interfaces.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of LogicalInterface objects

namespace_create(obj)

Create new namespace.

Parameters:objNamespace object
namespace_delete(fq_name=None, id=None, ifmap_id=None)

Delete namespace from the system.

Parameters:
  • fq_name – Fully qualified name of namespace
  • id – UUID of namespace
  • ifmap_id – IFMAP id of namespace
namespace_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return namespace information.

Parameters:
  • fq_name – Fully qualified name of namespace
  • fq_name_str – Fully qualified name string of namespace
  • id – UUID of namespace
  • ifmap_id – IFMAP id of namespace
Returns:

Namespace object

namespace_update(obj)

Update namespace.

Parameters:objNamespace object
namespaces_list(parent_id=None, parent_fq_name=None)

List all namespaces.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of Namespace objects

network_ipam_create(obj)

Create new network-ipam.

Parameters:objNetworkIpam object
network_ipam_delete(fq_name=None, id=None, ifmap_id=None)

Delete network-ipam from the system.

Parameters:
  • fq_name – Fully qualified name of network-ipam
  • id – UUID of network-ipam
  • ifmap_id – IFMAP id of network-ipam
network_ipam_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return network-ipam information.

Parameters:
  • fq_name – Fully qualified name of network-ipam
  • fq_name_str – Fully qualified name string of network-ipam
  • id – UUID of network-ipam
  • ifmap_id – IFMAP id of network-ipam
Returns:

NetworkIpam object

network_ipam_update(obj)

Update network-ipam.

Parameters:objNetworkIpam object
network_ipams_list(parent_id=None, parent_fq_name=None)

List all network-ipams.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of NetworkIpam objects

network_policy_create(obj)

Create new network-policy.

Parameters:objNetworkPolicy object
network_policy_delete(fq_name=None, id=None, ifmap_id=None)

Delete network-policy from the system.

Parameters:
  • fq_name – Fully qualified name of network-policy
  • id – UUID of network-policy
  • ifmap_id – IFMAP id of network-policy
network_policy_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return network-policy information.

Parameters:
  • fq_name – Fully qualified name of network-policy
  • fq_name_str – Fully qualified name string of network-policy
  • id – UUID of network-policy
  • ifmap_id – IFMAP id of network-policy
Returns:

NetworkPolicy object

network_policy_update(obj)

Update network-policy.

Parameters:objNetworkPolicy object
network_policys_list(parent_id=None, parent_fq_name=None)

List all network-policys.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of NetworkPolicy objects

physical_interface_create(obj)

Create new physical-interface.

Parameters:objPhysicalInterface object
physical_interface_delete(fq_name=None, id=None, ifmap_id=None)

Delete physical-interface from the system.

Parameters:
  • fq_name – Fully qualified name of physical-interface
  • id – UUID of physical-interface
  • ifmap_id – IFMAP id of physical-interface
physical_interface_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return physical-interface information.

Parameters:
  • fq_name – Fully qualified name of physical-interface
  • fq_name_str – Fully qualified name string of physical-interface
  • id – UUID of physical-interface
  • ifmap_id – IFMAP id of physical-interface
Returns:

PhysicalInterface object

physical_interface_update(obj)

Update physical-interface.

Parameters:objPhysicalInterface object
physical_interfaces_list(parent_id=None, parent_fq_name=None)

List all physical-interfaces.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of PhysicalInterface objects

physical_router_create(obj)

Create new physical-router.

Parameters:objPhysicalRouter object
physical_router_delete(fq_name=None, id=None, ifmap_id=None)

Delete physical-router from the system.

Parameters:
  • fq_name – Fully qualified name of physical-router
  • id – UUID of physical-router
  • ifmap_id – IFMAP id of physical-router
physical_router_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return physical-router information.

Parameters:
  • fq_name – Fully qualified name of physical-router
  • fq_name_str – Fully qualified name string of physical-router
  • id – UUID of physical-router
  • ifmap_id – IFMAP id of physical-router
Returns:

PhysicalRouter object

physical_router_update(obj)

Update physical-router.

Parameters:objPhysicalRouter object
physical_routers_list(parent_id=None, parent_fq_name=None)

List all physical-routers.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of PhysicalRouter objects

project_create(obj)

Create new project.

Parameters:objProject object
project_delete(fq_name=None, id=None, ifmap_id=None)

Delete project from the system.

Parameters:
  • fq_name – Fully qualified name of project
  • id – UUID of project
  • ifmap_id – IFMAP id of project
project_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return project information.

Parameters:
  • fq_name – Fully qualified name of project
  • fq_name_str – Fully qualified name string of project
  • id – UUID of project
  • ifmap_id – IFMAP id of project
Returns:

Project object

project_update(obj)

Update project.

Parameters:objProject object
projects_list(parent_id=None, parent_fq_name=None)

List all projects.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of Project objects

provider_attachment_create(obj)

Create new provider-attachment.

Parameters:objProviderAttachment object
provider_attachment_delete(fq_name=None, id=None, ifmap_id=None)

Delete provider-attachment from the system.

Parameters:
  • fq_name – Fully qualified name of provider-attachment
  • id – UUID of provider-attachment
  • ifmap_id – IFMAP id of provider-attachment
provider_attachment_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return provider-attachment information.

Parameters:
  • fq_name – Fully qualified name of provider-attachment
  • fq_name_str – Fully qualified name string of provider-attachment
  • id – UUID of provider-attachment
  • ifmap_id – IFMAP id of provider-attachment
Returns:

ProviderAttachment object

provider_attachment_update(obj)

Update provider-attachment.

Parameters:objProviderAttachment object
provider_attachments_list()

List all provider-attachments.

route_table_create(obj)

Create new route-table.

Parameters:objRouteTable object
route_table_delete(fq_name=None, id=None, ifmap_id=None)

Delete route-table from the system.

Parameters:
  • fq_name – Fully qualified name of route-table
  • id – UUID of route-table
  • ifmap_id – IFMAP id of route-table
route_table_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return route-table information.

Parameters:
  • fq_name – Fully qualified name of route-table
  • fq_name_str – Fully qualified name string of route-table
  • id – UUID of route-table
  • ifmap_id – IFMAP id of route-table
Returns:

RouteTable object

route_table_update(obj)

Update route-table.

Parameters:objRouteTable object
route_tables_list(parent_id=None, parent_fq_name=None)

List all route-tables.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of RouteTable objects

route_target_create(obj)

Create new route-target.

Parameters:objRouteTarget object
route_target_delete(fq_name=None, id=None, ifmap_id=None)

Delete route-target from the system.

Parameters:
  • fq_name – Fully qualified name of route-target
  • id – UUID of route-target
  • ifmap_id – IFMAP id of route-target
route_target_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return route-target information.

Parameters:
  • fq_name – Fully qualified name of route-target
  • fq_name_str – Fully qualified name string of route-target
  • id – UUID of route-target
  • ifmap_id – IFMAP id of route-target
Returns:

RouteTarget object

route_target_update(obj)

Update route-target.

Parameters:objRouteTarget object
route_targets_list()

List all route-targets.

routing_instance_create(obj)

Create new routing-instance.

Parameters:objRoutingInstance object
routing_instance_delete(fq_name=None, id=None, ifmap_id=None)

Delete routing-instance from the system.

Parameters:
  • fq_name – Fully qualified name of routing-instance
  • id – UUID of routing-instance
  • ifmap_id – IFMAP id of routing-instance
routing_instance_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return routing-instance information.

Parameters:
  • fq_name – Fully qualified name of routing-instance
  • fq_name_str – Fully qualified name string of routing-instance
  • id – UUID of routing-instance
  • ifmap_id – IFMAP id of routing-instance
Returns:

RoutingInstance object

routing_instance_update(obj)

Update routing-instance.

Parameters:objRoutingInstance object
routing_instances_list(parent_id=None, parent_fq_name=None)

List all routing-instances.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of RoutingInstance objects

security_group_create(obj)

Create new security-group.

Parameters:objSecurityGroup object
security_group_delete(fq_name=None, id=None, ifmap_id=None)

Delete security-group from the system.

Parameters:
  • fq_name – Fully qualified name of security-group
  • id – UUID of security-group
  • ifmap_id – IFMAP id of security-group
security_group_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return security-group information.

Parameters:
  • fq_name – Fully qualified name of security-group
  • fq_name_str – Fully qualified name string of security-group
  • id – UUID of security-group
  • ifmap_id – IFMAP id of security-group
Returns:

SecurityGroup object

security_group_update(obj)

Update security-group.

Parameters:objSecurityGroup object
security_groups_list(parent_id=None, parent_fq_name=None)

List all security-groups.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of SecurityGroup objects

service_instance_create(obj)

Create new service-instance.

Parameters:objServiceInstance object
service_instance_delete(fq_name=None, id=None, ifmap_id=None)

Delete service-instance from the system.

Parameters:
  • fq_name – Fully qualified name of service-instance
  • id – UUID of service-instance
  • ifmap_id – IFMAP id of service-instance
service_instance_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return service-instance information.

Parameters:
  • fq_name – Fully qualified name of service-instance
  • fq_name_str – Fully qualified name string of service-instance
  • id – UUID of service-instance
  • ifmap_id – IFMAP id of service-instance
Returns:

ServiceInstance object

service_instance_update(obj)

Update service-instance.

Parameters:objServiceInstance object
service_instances_list(parent_id=None, parent_fq_name=None)

List all service-instances.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of ServiceInstance objects

service_template_create(obj)

Create new service-template.

Parameters:objServiceTemplate object
service_template_delete(fq_name=None, id=None, ifmap_id=None)

Delete service-template from the system.

Parameters:
  • fq_name – Fully qualified name of service-template
  • id – UUID of service-template
  • ifmap_id – IFMAP id of service-template
service_template_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return service-template information.

Parameters:
  • fq_name – Fully qualified name of service-template
  • fq_name_str – Fully qualified name string of service-template
  • id – UUID of service-template
  • ifmap_id – IFMAP id of service-template
Returns:

ServiceTemplate object

service_template_update(obj)

Update service-template.

Parameters:objServiceTemplate object
service_templates_list(parent_id=None, parent_fq_name=None)

List all service-templates.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of ServiceTemplate objects

virtual_DNS_create(obj)

Create new virtual-DNS.

Parameters:objVirtualDns object
virtual_DNS_delete(fq_name=None, id=None, ifmap_id=None)

Delete virtual-DNS from the system.

Parameters:
  • fq_name – Fully qualified name of virtual-DNS
  • id – UUID of virtual-DNS
  • ifmap_id – IFMAP id of virtual-DNS
virtual_DNS_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return virtual-DNS information.

Parameters:
  • fq_name – Fully qualified name of virtual-DNS
  • fq_name_str – Fully qualified name string of virtual-DNS
  • id – UUID of virtual-DNS
  • ifmap_id – IFMAP id of virtual-DNS
Returns:

VirtualDns object

virtual_DNS_record_create(obj)

Create new virtual-DNS-record.

Parameters:objVirtualDnsRecord object
virtual_DNS_record_delete(fq_name=None, id=None, ifmap_id=None)

Delete virtual-DNS-record from the system.

Parameters:
  • fq_name – Fully qualified name of virtual-DNS-record
  • id – UUID of virtual-DNS-record
  • ifmap_id – IFMAP id of virtual-DNS-record
virtual_DNS_record_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return virtual-DNS-record information.

Parameters:
  • fq_name – Fully qualified name of virtual-DNS-record
  • fq_name_str – Fully qualified name string of virtual-DNS-record
  • id – UUID of virtual-DNS-record
  • ifmap_id – IFMAP id of virtual-DNS-record
Returns:

VirtualDnsRecord object

virtual_DNS_record_update(obj)

Update virtual-DNS-record.

Parameters:objVirtualDnsRecord object
virtual_DNS_records_list(parent_id=None, parent_fq_name=None)

List all virtual-DNS-records.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of VirtualDnsRecord objects

virtual_DNS_update(obj)

Update virtual-DNS.

Parameters:objVirtualDns object
virtual_DNSs_list(parent_id=None, parent_fq_name=None)

List all virtual-DNSs.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of VirtualDns objects

virtual_machine_create(obj)

Create new virtual-machine.

Parameters:objVirtualMachine object
virtual_machine_delete(fq_name=None, id=None, ifmap_id=None)

Delete virtual-machine from the system.

Parameters:
  • fq_name – Fully qualified name of virtual-machine
  • id – UUID of virtual-machine
  • ifmap_id – IFMAP id of virtual-machine
virtual_machine_interface_create(obj)

Create new virtual-machine-interface.

Parameters:objVirtualMachineInterface object
virtual_machine_interface_delete(fq_name=None, id=None, ifmap_id=None)

Delete virtual-machine-interface from the system.

Parameters:
  • fq_name – Fully qualified name of virtual-machine-interface
  • id – UUID of virtual-machine-interface
  • ifmap_id – IFMAP id of virtual-machine-interface
virtual_machine_interface_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return virtual-machine-interface information.

Parameters:
  • fq_name – Fully qualified name of virtual-machine-interface
  • fq_name_str – Fully qualified name string of virtual-machine-interface
  • id – UUID of virtual-machine-interface
  • ifmap_id – IFMAP id of virtual-machine-interface
Returns:

VirtualMachineInterface object

virtual_machine_interface_update(obj)

Update virtual-machine-interface.

Parameters:objVirtualMachineInterface object
virtual_machine_interfaces_list(parent_id=None, parent_fq_name=None)

List all virtual-machine-interfaces.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of VirtualMachineInterface objects

virtual_machine_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return virtual-machine information.

Parameters:
  • fq_name – Fully qualified name of virtual-machine
  • fq_name_str – Fully qualified name string of virtual-machine
  • id – UUID of virtual-machine
  • ifmap_id – IFMAP id of virtual-machine
Returns:

VirtualMachine object

virtual_machine_update(obj)

Update virtual-machine.

Parameters:objVirtualMachine object
virtual_machines_list()

List all virtual-machines.

virtual_network_create(obj)

Create new virtual-network.

Parameters:objVirtualNetwork object
virtual_network_delete(fq_name=None, id=None, ifmap_id=None)

Delete virtual-network from the system.

Parameters:
  • fq_name – Fully qualified name of virtual-network
  • id – UUID of virtual-network
  • ifmap_id – IFMAP id of virtual-network
virtual_network_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return virtual-network information.

Parameters:
  • fq_name – Fully qualified name of virtual-network
  • fq_name_str – Fully qualified name string of virtual-network
  • id – UUID of virtual-network
  • ifmap_id – IFMAP id of virtual-network
Returns:

VirtualNetwork object

virtual_network_update(obj)

Update virtual-network.

Parameters:objVirtualNetwork object
virtual_networks_list(parent_id=None, parent_fq_name=None)

List all virtual-networks.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of VirtualNetwork objects

virtual_router_create(obj)

Create new virtual-router.

Parameters:objVirtualRouter object
virtual_router_delete(fq_name=None, id=None, ifmap_id=None)

Delete virtual-router from the system.

Parameters:
  • fq_name – Fully qualified name of virtual-router
  • id – UUID of virtual-router
  • ifmap_id – IFMAP id of virtual-router
virtual_router_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return virtual-router information.

Parameters:
  • fq_name – Fully qualified name of virtual-router
  • fq_name_str – Fully qualified name string of virtual-router
  • id – UUID of virtual-router
  • ifmap_id – IFMAP id of virtual-router
Returns:

VirtualRouter object

virtual_router_update(obj)

Update virtual-router.

Parameters:objVirtualRouter object
virtual_routers_list(parent_id=None, parent_fq_name=None)

List all virtual-routers.

Parameters:
  • parent_id – UUID of parent as optional search filter
  • parent_fq_name – full qualified name of parent as optional search filter
Returns:

list of VirtualRouter objects

generatedssuper Module

resource_client 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:

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:

Children:

References to:
Referred by:
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:
Children:

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:

Children:

References to:

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:
Children:

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:
Referred by:
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:
Children:

References to:

Referred by:
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:
References to:

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:

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:

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:

Children:

References to:

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:

Children:

References to:

Referred by:
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:

Children:

References to:
Referred by:
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:

Children:

References to:

Referred by:
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:
Children:

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:
Children:
References to:

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:
Children:
References to:
Referred by:
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:

Children:

References to:

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:

Children:

References to:

Referred by:
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:

Children:

References to:

Referred by:
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:
Children:
References to:
Referred by:
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:
Children:

References to:

Referred by:
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:

Children:

References to:
Referred by:
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:

Children:

References to:

Referred by:
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:
Children:

References to:

Referred by:
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:

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:
Children:
References to:
Referred by:
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:

Children:

References to:
Referred by:
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:
Children:
References to:
Referred by:
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:
Referred by:
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_server Module

resource_test Module

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)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

AclEntriesType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.AclRuleType(match_condition=None, action_list=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

AclRuleType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ActionListType(simple_action=None, gateway_name=None, apply_service=None, mirror_to=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ActionListType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.AddressFamilies(family=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

AddressFamilies class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.AddressType(subnet=None, virtual_network=None, security_group=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

AddressType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ApiAccessListType(api_access=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ApiAccessListType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ApiAccessType(api_name=None, permissions=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ApiAccessType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.AttachmentAddressType(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

AttachmentAddressType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.AttachmentInfoType(static=None, bgp=None, ospf=None, state=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

AttachmentInfoType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.BgpPeeringAttributes(session=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

BgpPeeringAttributes class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.BgpRouterParams(vendor=None, vnc_managed=None, autonomous_system=None, identifier=None, address=None, port=None, address_families=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

BgpRouterParams class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.BgpSession(uuid=None, attributes=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

BgpSession class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.BgpSessionAttributes(bgp_router=None, address_families=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

BgpSessionAttributes class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.BindingType(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

BindingType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ConnectionType(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ConnectionType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.DefaultProtocolType(bgp=None, ospf=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

DefaultProtocolType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.DhcpOptionType(dhcp_option_name=None, dhcp_option_value=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

DhcpOptionType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.DhcpOptionsListType(dhcp_option=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

DhcpOptionsListType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.DomainLimitsType(project_limit=None, virtual_network_limit=None, security_group_limit=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

DomainLimitsType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.EncapsulationPrioritiesType(encapsulation=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

EncapsulationPrioritiesType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.FloatingIpPoolType(subnet=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

FloatingIpPoolType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.IdPermsType(permissions=None, uuid=None, enable=None, created=None, last_modified=None, description=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

IdPermsType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.InstanceTargetType(import_export=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

InstanceTargetType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.InterfaceMirrorType(traffic_direction=None, mirror_to=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

InterfaceMirrorType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.IpAddressesType(ip_address=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

IpAddressesType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.IpamDnsAddressType(tenant_dns_server_address=None, virtual_dns_server_name=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

IpamDnsAddressType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.IpamSubnetType(subnet=None, default_gateway=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

IpamSubnetType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.IpamType(ipam_method=None, ipam_dns_method=None, ipam_dns_server=None, dhcp_option_list=None, cidr_block=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

IpamType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.LinklocalServiceEntryType(linklocal_service_name=None, linklocal_service_ip=None, linklocal_service_port=None, ip_fabric_DNS_service_name=None, ip_fabric_service_port=None, ip_fabric_service_ip=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

LinklocalServiceEntryType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.LinklocalServicesTypes(linklocal_service_entry=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

LinklocalServicesTypes class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.MacAddressesType(mac_address=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

MacAddressesType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.MatchConditionType(protocol=None, src_address=None, src_port=None, dst_address=None, dst_port=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

MatchConditionType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.MirrorActionType(analyzer_name=None, encapsulation=None, analyzer_ip_address=None, routing_instance=None, udp_port=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

MirrorActionType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.PermType(owner=None, owner_access=None, group=None, group_access=None, other_access=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

PermType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.PolicyBasedForwardingRuleType(direction=None, vlan_tag=None, src_mac=None, dst_mac=None, mpls_label=None, service_chain_address=None, protocol=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

PolicyBasedForwardingRuleType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.PolicyEntriesType(policy_rule=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

PolicyEntriesType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.PolicyRuleType(rule_sequence=None, rule_uuid=None, direction=None, simple_action=None, protocol=None, src_addresses=None, src_ports=None, application=None, dst_addresses=None, dst_ports=None, action_list=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

PolicyRuleType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.PortType(start_port=None, end_port=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

PortType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ProtocolBgpType(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ProtocolBgpType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ProtocolOspfType(area=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ProtocolOspfType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ProtocolStaticType(route=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ProtocolStaticType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.RouteTableType(route=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

RouteTableType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.RouteTargetList(route_target=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

RouteTargetList class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.RouteType(prefix=None, next_hop=None, next_hop_type=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

RouteType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.SequenceType(major=None, minor=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

SequenceType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ServiceChainInfo(routing_instance=None, prefix=None, service_chain_address=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ServiceChainInfo class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ServiceInstanceType(auto_policy=False, management_virtual_network=None, left_virtual_network=None, left_ip_address=None, right_virtual_network=None, right_ip_address=None, scale_out=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ServiceInstanceType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ServiceScaleOutType(max_instances=1, auto_scale=False, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ServiceScaleOutType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ServiceTemplateInterfaceType(service_interface_type=None, shared_ip=False, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ServiceTemplateInterfaceType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.ServiceTemplateType(service_mode=None, service_type=None, image_name=None, service_scaling=False, interface_type=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

ServiceTemplateType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.StaticRouteEntriesType(route=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

StaticRouteEntriesType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.StaticRouteType(prefix=None, next_hop=None, route_target=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

StaticRouteType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.SubnetType(ip_prefix=None, ip_prefix_len=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

SubnetType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.TimerType(start_time=None, on_interval=None, off_interval=None, end_time=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

TimerType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.UuidType(uuid_mslong=None, uuid_lslong=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

UuidType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.VirtualDnsRecordType(record_name=None, record_type=None, record_class=None, record_data=None, record_ttl_seconds=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

VirtualDnsRecordType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.VirtualDnsType(domain_name=None, dynamic_records_from_client=None, record_order=None, default_ttl_seconds=None, next_virtual_DNS=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

VirtualDnsType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.VirtualMachineInterfacePropertiesType(service_interface_type=None, interface_mirror=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

VirtualMachineInterfacePropertiesType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.VirtualNetworkPolicyType(sequence=None, timer=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

VirtualNetworkPolicyType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.VirtualNetworkType(extend_to_external_routers=None, network_id=None, vxlan_network_identifier=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

VirtualNetworkType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.VnSubnetsType(ipam_subnets=None, **kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

VnSubnetsType class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.config_root_domain(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

config_root_domain class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.config_root_global_system_config(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

config_root_global_system_config class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.customer_attachment_floating_ip(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

customer_attachment_floating_ip class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.customer_attachment_virtual_machine_interface(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

customer_attachment_virtual_machine_interface class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.domain_namespace(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

domain_namespace class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.domain_project(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

domain_project class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.domain_service_template(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

domain_service_template class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.domain_virtual_DNS(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

domain_virtual_DNS class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.floating_ip_pool_floating_ip(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

floating_ip_pool_floating_ip class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.floating_ip_project(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

floating_ip_project class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.floating_ip_virtual_machine_interface(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

floating_ip_virtual_machine_interface class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.global_system_config_bgp_router(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

global_system_config_bgp_router class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.global_system_config_global_vrouter_config(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

global_system_config_global_vrouter_config class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.global_system_config_physical_router(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

global_system_config_physical_router class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.global_system_config_virtual_router(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

global_system_config_virtual_router class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.instance_bgp_router(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

instance_bgp_router class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.instance_ip_virtual_machine_interface(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

instance_ip_virtual_machine_interface class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.instance_ip_virtual_network(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

instance_ip_virtual_network class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.logical_interface_virtual_network(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

logical_interface_virtual_network class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.mac_address(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

mac_address class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.network_ipam_virtual_DNS(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

network_ipam_virtual_DNS class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.physical_interface_logical_interface(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

physical_interface_logical_interface class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.physical_router_bgp_router(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

physical_router_bgp_router class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.physical_router_physical_interface(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

physical_router_physical_interface class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.project_floating_ip_pool(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

project_floating_ip_pool class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.project_network_ipam(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

project_network_ipam class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.project_network_policy(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

project_network_policy class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.project_route_table(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

project_route_table class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.project_security_group(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

project_security_group class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.project_service_instance(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

project_service_instance class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.project_virtual_network(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

project_virtual_network class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.provider_attachment_virtual_router(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

provider_attachment_virtual_router class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.security_group_access_control_list(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

security_group_access_control_list class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.service_instance_service_template(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

service_instance_service_template class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.state(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

state class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_DNS_virtual_DNS_record(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_DNS_virtual_DNS_record class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_machine_interface_security_group(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_machine_interface_security_group class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_machine_interface_virtual_network(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_machine_interface_virtual_network class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_machine_service_instance(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_machine_service_instance class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_machine_virtual_machine_interface(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_machine_virtual_machine_interface class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_network_access_control_list(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_network_access_control_list class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_network_floating_ip_pool(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_network_floating_ip_pool class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_network_route_table(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_network_route_table class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_network_routing_instance(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_network_routing_instance class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_router_bgp_router(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_router_bgp_router class definition from vnc_cfg.xsd

class vnc_cfg_api_server.gen.resource_xsd.virtual_router_virtual_machine(**kwargs)

Bases: vnc_cfg_api_server.gen.generatedssuper.GeneratedsSuper

virtual_router_virtual_machine class definition from vnc_cfg.xsd

vnc_api_client_gen Module

vnc_api_schema Module

vnc_api_server_gen Module

vnc_api_test_gen Module

vnc_cassandra_client_gen Module

vnc_ifmap_client_gen Module