vnc_cfg_api_server.gen package

Submodules

vnc_cfg_api_server.gen.cfixture module

vnc_cfg_api_server.gen.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, obj_uuids=None, fields=None, detail=False, count=False)

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

alarm_create(obj)

Create new alarm.

Parameters:objAlarm object
alarm_delete(fq_name=None, id=None, ifmap_id=None)

Delete alarm from the system.

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

Return alarm information.

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

Alarm object

alarm_update(obj)

Update alarm.

Parameters:objAlarm object
alarms_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all alarms.

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 Alarm objects

alias_ip_create(obj)

Create new alias-ip.

Parameters:objAliasIp object
alias_ip_delete(fq_name=None, id=None, ifmap_id=None)

Delete alias-ip from the system.

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

Create new alias-ip-pool.

Parameters:objAliasIpPool object
alias_ip_pool_delete(fq_name=None, id=None, ifmap_id=None)

Delete alias-ip-pool from the system.

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

Return alias-ip-pool information.

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

AliasIpPool object

alias_ip_pool_update(obj)

Update alias-ip-pool.

Parameters:objAliasIpPool object
alias_ip_pools_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all alias-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 AliasIpPool objects

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

Return alias-ip information.

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

AliasIp object

alias_ip_update(obj)

Update alias-ip.

Parameters:objAliasIp object
alias_ips_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all alias-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 AliasIp objects

analytics_node_create(obj)

Create new analytics-node.

Parameters:objAnalyticsNode object
analytics_node_delete(fq_name=None, id=None, ifmap_id=None)

Delete analytics-node from the system.

Parameters:
  • fq_name – Fully qualified name of analytics-node
  • id – UUID of analytics-node
  • ifmap_id – IFMAP id of analytics-node
analytics_node_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return analytics-node information.

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

AnalyticsNode object

analytics_node_update(obj)

Update analytics-node.

Parameters:objAnalyticsNode object
analytics_nodes_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all analytics-nodes.

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 AnalyticsNode objects

api_access_list_create(obj)

Create new api-access-list.

Parameters:objApiAccessList object
api_access_list_delete(fq_name=None, id=None, ifmap_id=None)

Delete api-access-list from the system.

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

Return api-access-list information.

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

ApiAccessList object

api_access_list_update(obj)

Update api-access-list.

Parameters:objApiAccessList object
api_access_lists_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all api-access-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 ApiAccessList objects

bgp_as_a_service_create(obj)

Create new bgp-as-a-service.

Parameters:objBgpAsAService object
bgp_as_a_service_delete(fq_name=None, id=None, ifmap_id=None)

Delete bgp-as-a-service from the system.

Parameters:
  • fq_name – Fully qualified name of bgp-as-a-service
  • id – UUID of bgp-as-a-service
  • ifmap_id – IFMAP id of bgp-as-a-service
bgp_as_a_service_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return bgp-as-a-service information.

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

BgpAsAService object

bgp_as_a_service_update(obj)

Update bgp-as-a-service.

Parameters:objBgpAsAService object
bgp_as_a_services_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all bgp-as-a-services.

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 BgpAsAService 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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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_node_create(obj)

Create new config-node.

Parameters:objConfigNode object
config_node_delete(fq_name=None, id=None, ifmap_id=None)

Delete config-node from the system.

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

Return config-node information.

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

ConfigNode object

config_node_update(obj)

Update config-node.

Parameters:objConfigNode object
config_nodes_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all config-nodes.

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 ConfigNode 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(obj_uuids=None, fields=None, detail=False, count=False)

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(back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all customer-attachments.

database_node_create(obj)

Create new database-node.

Parameters:objDatabaseNode object
database_node_delete(fq_name=None, id=None, ifmap_id=None)

Delete database-node from the system.

Parameters:
  • fq_name – Fully qualified name of database-node
  • id – UUID of database-node
  • ifmap_id – IFMAP id of database-node
database_node_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return database-node information.

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

DatabaseNode object

database_node_update(obj)

Update database-node.

Parameters:objDatabaseNode object
database_nodes_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all database-nodes.

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 DatabaseNode objects

discovery_service_assignment_create(obj)

Create new discovery-service-assignment.

Parameters:objDiscoveryServiceAssignment object
discovery_service_assignment_delete(fq_name=None, id=None, ifmap_id=None)

Delete discovery-service-assignment from the system.

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

Return discovery-service-assignment information.

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

DiscoveryServiceAssignment object

discovery_service_assignment_update(obj)

Update discovery-service-assignment.

Parameters:objDiscoveryServiceAssignment object
discovery_service_assignments_list(obj_uuids=None, fields=None, detail=False, count=False)

List all discovery-service-assignments.

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, obj_uuids=None, fields=None, detail=False, count=False)

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

dsa_rule_create(obj)

Create new dsa-rule.

Parameters:objDsaRule object
dsa_rule_delete(fq_name=None, id=None, ifmap_id=None)

Delete dsa-rule from the system.

Parameters:
  • fq_name – Fully qualified name of dsa-rule
  • id – UUID of dsa-rule
  • ifmap_id – IFMAP id of dsa-rule
dsa_rule_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return dsa-rule information.

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

DsaRule object

dsa_rule_update(obj)

Update dsa-rule.

Parameters:objDsaRule object
dsa_rules_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all dsa-rules.

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 DsaRule 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, obj_uuids=None, fields=None, detail=False, count=False)

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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

forwarding_class_create(obj)

Create new forwarding-class.

Parameters:objForwardingClass object
forwarding_class_delete(fq_name=None, id=None, ifmap_id=None)

Delete forwarding-class from the system.

Parameters:
  • fq_name – Fully qualified name of forwarding-class
  • id – UUID of forwarding-class
  • ifmap_id – IFMAP id of forwarding-class
forwarding_class_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return forwarding-class information.

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

ForwardingClass object

forwarding_class_update(obj)

Update forwarding-class.

Parameters:objForwardingClass object
forwarding_classs_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all forwarding-classs.

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 ForwardingClass objects

get_default_access_control_list_id()

Return UUID of default access-control-list.

get_default_alarm_id()

Return UUID of default alarm.

get_default_alias_ip_id()

Return UUID of default alias-ip.

get_default_alias_ip_pool_id()

Return UUID of default alias-ip-pool.

get_default_analytics_node_id()

Return UUID of default analytics-node.

get_default_api_access_list_id()

Return UUID of default api-access-list.

get_default_bgp_as_a_service_id()

Return UUID of default bgp-as-a-service.

get_default_bgp_router_id()

Return UUID of default bgp-router.

get_default_config_node_id()

Return UUID of default config-node.

get_default_config_root_id()

Return UUID of default config-root.

get_default_customer_attachment_id()

Return UUID of default customer-attachment.

get_default_database_node_id()

Return UUID of default database-node.

get_default_discovery_service_assignment_id()

Return UUID of default discovery-service-assignment.

get_default_domain_id()

Return UUID of default domain.

get_default_dsa_rule_id()

Return UUID of default dsa-rule.

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_forwarding_class_id()

Return UUID of default forwarding-class.

get_default_global_qos_config_id()

Return UUID of default global-qos-config.

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_interface_route_table_id()

Return UUID of default interface-route-table.

get_default_loadbalancer_healthmonitor_id()

Return UUID of default loadbalancer-healthmonitor.

get_default_loadbalancer_id()

Return UUID of default loadbalancer.

get_default_loadbalancer_listener_id()

Return UUID of default loadbalancer-listener.

get_default_loadbalancer_member_id()

Return UUID of default loadbalancer-member.

get_default_loadbalancer_pool_id()

Return UUID of default loadbalancer-pool.

get_default_logical_interface_id()

Return UUID of default logical-interface.

get_default_logical_router_id()

Return UUID of default logical-router.

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_port_tuple_id()

Return UUID of default port-tuple.

get_default_project_id()

Return UUID of default project.

get_default_provider_attachment_id()

Return UUID of default provider-attachment.

get_default_qos_config_id()

Return UUID of default qos-config.

get_default_qos_queue_id()

Return UUID of default qos-queue.

get_default_route_aggregate_id()

Return UUID of default route-aggregate.

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_routing_policy_id()

Return UUID of default routing-policy.

get_default_security_group_id()

Return UUID of default security-group.

get_default_service_appliance_id()

Return UUID of default service-appliance.

get_default_service_appliance_set_id()

Return UUID of default service-appliance-set.

get_default_service_health_check_id()

Return UUID of default service-health-check.

get_default_service_instance_id()

Return UUID of default service-instance.

get_default_service_template_id()

Return UUID of default service-template.

get_default_subnet_id()

Return UUID of default subnet.

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_ip_id()

Return UUID of default virtual-ip.

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_qos_config_create(obj)

Create new global-qos-config.

Parameters:objGlobalQosConfig object
global_qos_config_delete(fq_name=None, id=None, ifmap_id=None)

Delete global-qos-config from the system.

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

Return global-qos-config information.

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

GlobalQosConfig object

global_qos_config_update(obj)

Update global-qos-config.

Parameters:objGlobalQosConfig object
global_qos_configs_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all global-qos-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 GlobalQosConfig objects

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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, obj_uuids=None, fields=None, detail=False, count=False)

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(back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all instance-ips.

interface_route_table_create(obj)

Create new interface-route-table.

Parameters:objInterfaceRouteTable object
interface_route_table_delete(fq_name=None, id=None, ifmap_id=None)

Delete interface-route-table from the system.

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

Return interface-route-table information.

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

InterfaceRouteTable object

interface_route_table_update(obj)

Update interface-route-table.

Parameters:objInterfaceRouteTable object
interface_route_tables_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all interface-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 InterfaceRouteTable objects

loadbalancer_create(obj)

Create new loadbalancer.

Parameters:objLoadbalancer object
loadbalancer_delete(fq_name=None, id=None, ifmap_id=None)

Delete loadbalancer from the system.

Parameters:
  • fq_name – Fully qualified name of loadbalancer
  • id – UUID of loadbalancer
  • ifmap_id – IFMAP id of loadbalancer
loadbalancer_healthmonitor_create(obj)

Create new loadbalancer-healthmonitor.

Parameters:objLoadbalancerHealthmonitor object
loadbalancer_healthmonitor_delete(fq_name=None, id=None, ifmap_id=None)

Delete loadbalancer-healthmonitor from the system.

Parameters:
  • fq_name – Fully qualified name of loadbalancer-healthmonitor
  • id – UUID of loadbalancer-healthmonitor
  • ifmap_id – IFMAP id of loadbalancer-healthmonitor
loadbalancer_healthmonitor_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return loadbalancer-healthmonitor information.

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

LoadbalancerHealthmonitor object

loadbalancer_healthmonitor_update(obj)

Update loadbalancer-healthmonitor.

Parameters:objLoadbalancerHealthmonitor object
loadbalancer_healthmonitors_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all loadbalancer-healthmonitors.

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 LoadbalancerHealthmonitor objects

loadbalancer_listener_create(obj)

Create new loadbalancer-listener.

Parameters:objLoadbalancerListener object
loadbalancer_listener_delete(fq_name=None, id=None, ifmap_id=None)

Delete loadbalancer-listener from the system.

Parameters:
  • fq_name – Fully qualified name of loadbalancer-listener
  • id – UUID of loadbalancer-listener
  • ifmap_id – IFMAP id of loadbalancer-listener
loadbalancer_listener_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return loadbalancer-listener information.

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

LoadbalancerListener object

loadbalancer_listener_update(obj)

Update loadbalancer-listener.

Parameters:objLoadbalancerListener object
loadbalancer_listeners_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all loadbalancer-listeners.

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 LoadbalancerListener objects

loadbalancer_member_create(obj)

Create new loadbalancer-member.

Parameters:objLoadbalancerMember object
loadbalancer_member_delete(fq_name=None, id=None, ifmap_id=None)

Delete loadbalancer-member from the system.

Parameters:
  • fq_name – Fully qualified name of loadbalancer-member
  • id – UUID of loadbalancer-member
  • ifmap_id – IFMAP id of loadbalancer-member
loadbalancer_member_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return loadbalancer-member information.

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

LoadbalancerMember object

loadbalancer_member_update(obj)

Update loadbalancer-member.

Parameters:objLoadbalancerMember object
loadbalancer_members_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all loadbalancer-members.

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 LoadbalancerMember objects

loadbalancer_pool_create(obj)

Create new loadbalancer-pool.

Parameters:objLoadbalancerPool object
loadbalancer_pool_delete(fq_name=None, id=None, ifmap_id=None)

Delete loadbalancer-pool from the system.

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

Return loadbalancer-pool information.

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

LoadbalancerPool object

loadbalancer_pool_update(obj)

Update loadbalancer-pool.

Parameters:objLoadbalancerPool object
loadbalancer_pools_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all loadbalancer-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 LoadbalancerPool objects

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

Return loadbalancer information.

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

Loadbalancer object

loadbalancer_update(obj)

Update loadbalancer.

Parameters:objLoadbalancer object
loadbalancers_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all loadbalancers.

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 Loadbalancer objects

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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

logical_router_create(obj)

Create new logical-router.

Parameters:objLogicalRouter object
logical_router_delete(fq_name=None, id=None, ifmap_id=None)

Delete logical-router from the system.

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

Return logical-router information.

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

LogicalRouter object

logical_router_update(obj)

Update logical-router.

Parameters:objLogicalRouter object
logical_routers_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all logical-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 LogicalRouter 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, obj_uuids=None, fields=None, detail=False, count=False)

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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, obj_uuids=None, fields=None, detail=False, count=False)

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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

port_tuple_create(obj)

Create new port-tuple.

Parameters:objPortTuple object
port_tuple_delete(fq_name=None, id=None, ifmap_id=None)

Delete port-tuple from the system.

Parameters:
  • fq_name – Fully qualified name of port-tuple
  • id – UUID of port-tuple
  • ifmap_id – IFMAP id of port-tuple
port_tuple_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return port-tuple information.

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

PortTuple object

port_tuple_update(obj)

Update port-tuple.

Parameters:objPortTuple object
port_tuples_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all port-tuples.

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 PortTuple 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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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(back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all provider-attachments.

qos_config_create(obj)

Create new qos-config.

Parameters:objQosConfig object
qos_config_delete(fq_name=None, id=None, ifmap_id=None)

Delete qos-config from the system.

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

Return qos-config information.

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

QosConfig object

qos_config_update(obj)

Update qos-config.

Parameters:objQosConfig object
qos_configs_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all qos-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 QosConfig objects

qos_queue_create(obj)

Create new qos-queue.

Parameters:objQosQueue object
qos_queue_delete(fq_name=None, id=None, ifmap_id=None)

Delete qos-queue from the system.

Parameters:
  • fq_name – Fully qualified name of qos-queue
  • id – UUID of qos-queue
  • ifmap_id – IFMAP id of qos-queue
qos_queue_read(fq_name=None, fq_name_str=None, id=None, ifmap_id=None)

Return qos-queue information.

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

QosQueue object

qos_queue_update(obj)

Update qos-queue.

Parameters:objQosQueue object
qos_queues_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all qos-queues.

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 QosQueue objects

route_aggregate_create(obj)

Create new route-aggregate.

Parameters:objRouteAggregate object
route_aggregate_delete(fq_name=None, id=None, ifmap_id=None)

Delete route-aggregate from the system.

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

Return route-aggregate information.

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

RouteAggregate object

route_aggregate_update(obj)

Update route-aggregate.

Parameters:objRouteAggregate object
route_aggregates_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all route-aggregates.

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 RouteAggregate objects

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, obj_uuids=None, fields=None, detail=False, count=False)

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(obj_uuids=None, fields=None, detail=False, count=False)

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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

routing_policy_create(obj)

Create new routing-policy.

Parameters:objRoutingPolicy object
routing_policy_delete(fq_name=None, id=None, ifmap_id=None)

Delete routing-policy from the system.

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

Return routing-policy information.

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

RoutingPolicy object

routing_policy_update(obj)

Update routing-policy.

Parameters:objRoutingPolicy object
routing_policys_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all routing-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 RoutingPolicy 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, obj_uuids=None, fields=None, detail=False, count=False)

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_appliance_create(obj)

Create new service-appliance.

Parameters:objServiceAppliance object
service_appliance_delete(fq_name=None, id=None, ifmap_id=None)

Delete service-appliance from the system.

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

Return service-appliance information.

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

ServiceAppliance object

service_appliance_set_create(obj)

Create new service-appliance-set.

Parameters:objServiceApplianceSet object
service_appliance_set_delete(fq_name=None, id=None, ifmap_id=None)

Delete service-appliance-set from the system.

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

Return service-appliance-set information.

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

ServiceApplianceSet object

service_appliance_set_update(obj)

Update service-appliance-set.

Parameters:objServiceApplianceSet object
service_appliance_sets_list(parent_id=None, parent_fq_name=None, obj_uuids=None, fields=None, detail=False, count=False)

List all service-appliance-sets.

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 ServiceApplianceSet objects

service_appliance_update(obj)

Update service-appliance.

Parameters:objServiceAppliance object
service_appliances_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all service-appliances.

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 ServiceAppliance objects

service_health_check_create(obj)

Create new service-health-check.

Parameters:objServiceHealthCheck object
service_health_check_delete(fq_name=None, id=None, ifmap_id=None)

Delete service-health-check from the system.

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

Return service-health-check information.

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

ServiceHealthCheck object

service_health_check_update(obj)

Update service-health-check.

Parameters:objServiceHealthCheck object
service_health_checks_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all service-health-checks.

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 ServiceHealthCheck 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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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

subnet_create(obj)

Create new subnet.

Parameters:objSubnet object
subnet_delete(fq_name=None, id=None, ifmap_id=None)

Delete subnet from the system.

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

Return subnet information.

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

Subnet object

subnet_update(obj)

Update subnet.

Parameters:objSubnet object
subnets_list(back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all subnets.

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, obj_uuids=None, fields=None, detail=False, count=False)

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, obj_uuids=None, fields=None, detail=False, count=False)

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_ip_create(obj)

Create new virtual-ip.

Parameters:objVirtualIp object
virtual_ip_delete(fq_name=None, id=None, ifmap_id=None)

Delete virtual-ip from the system.

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

Return virtual-ip information.

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

VirtualIp object

virtual_ip_update(obj)

Update virtual-ip.

Parameters:objVirtualIp object
virtual_ips_list(parent_id=None, parent_fq_name=None, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

List all virtual-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 VirtualIp 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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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(back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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, back_ref_id=None, obj_uuids=None, fields=None, detail=False, count=False)

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

vnc_cfg_api_server.gen.generatedssuper module

vnc_cfg_api_server.gen.resource_client module

vnc_cfg_api_server.gen.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, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents access-control-list configuration representation.

Child of:
VirtualNetwork object OR SecurityGroup object OR
Properties:
  • access_control_list_entries

    Type: AclEntriesType

    Created By: System

    Operations Allowed: CRUD

    Description:

    Automatically generated by system based on security groups or network policies.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

access_control_list_entries

Get access-control-list-entries for access-control-list.

Returns:AclEntriesType object
display_name

Get display-name for access-control-list.

Returns:xsd:string object
dump()

Display access-control-list object in compact form.

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_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_type()

Return object type (access-control-list).

id_perms

Get id-perms for access-control-list.

Returns:IdPermsType object
perms2

Get perms2 for access-control-list.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.Alarm(name=None, parent_obj=None, uve_keys=None, alarm_severity=None, alarm_rules=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents alarm configuration representation.

Child of:
GlobalSystemConfig object OR Project object OR
Properties:
  • uve_keys

    Type: string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of UVE tables or UVE objects where this alarm config should be applied. For example, rules

    based on NodeStatus UVE can be applied to multiple object types such as analytics-node, config-node,

    control-node, etc., Alarm config may also be applied to specific objects that can be specified as

    <uve-table-name>.<uve-name>

  • alarm_severity

    Type: int, within [0, 7]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Severity level for the alarm.

  • alarm_rules

    Type: AlarmOrList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Rules based on the UVE attributes specified as OR-of-ANDs of AlarmExpression template. Example:

    “alarm_rules”: {“or_list”: [{“and_list”: [{AlarmExpression1}, {AlarmExpression2}, ...]},

    {“and_list”: [{AlarmExpression3}, {AlarmExpression4}, ...]}]}

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

alarm_rules

Get alarm-rules for alarm.

Returns:AlarmOrList object
alarm_severity

Get alarm-severity for alarm.

Returns:AlarmSeverity object
display_name

Get display-name for alarm.

Returns:xsd:string object
dump()

Display alarm object in compact form.

get_fq_name()

Return FQN of alarm in list form.

get_fq_name_str()

Return FQN of alarm as colon delimited string.

get_parent_fq_name()

Return FQN of alarm’s parent in list form.

get_parent_fq_name_str()

Return FQN of alarm’s parent as colon delimted string.

get_type()

Return object type (alarm).

id_perms

Get id-perms for alarm.

Returns:IdPermsType object
perms2

Get perms2 for alarm.

Returns:PermType2 object
uve_keys

Get uve-keys for alarm.

Returns:xsd:string object
class vnc_cfg_api_server.gen.resource_common.AliasIp(name=None, parent_obj=None, alias_ip_address=None, alias_ip_address_family=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents alias-ip configuration representation.

Child of:
AliasIpPool object OR
Properties:
  • alias_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CR

    Description:

    Alias ip address.

  • alias_ip_address_family

    Type: string, one-of [u’v4’, u’v6’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip address family of the alias ip, IpV4 or IpV6

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of Project objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to project from which this alias ip was allocated.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual machine interface to which this alias ip is attached.

Referred by:

add_project(ref_obj)

Add project to alias-ip.

Parameters:ref_obj – Project object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to alias-ip.

Parameters:ref_obj – VirtualMachineInterface object
alias_ip_address

Get alias-ip-address for alias-ip.

Returns:IpAddressType object
alias_ip_address_family

Get alias-ip-address-family for alias-ip.

Returns:IpAddressFamilyType object
display_name

Get display-name for alias-ip.

Returns:xsd:string object
dump()

Display alias-ip object in compact form.

get_fq_name()

Return FQN of alias-ip in list form.

get_fq_name_str()

Return FQN of alias-ip as colon delimited string.

get_parent_fq_name()

Return FQN of alias-ip’s parent in list form.

get_parent_fq_name_str()

Return FQN of alias-ip’s parent as colon delimted string.

get_project_refs()

Return project list for alias-ip.

Returns:list of <Project>
get_type()

Return object type (alias-ip).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for alias-ip.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for alias-ip.

Returns:IdPermsType object
perms2

Get perms2 for alias-ip.

Returns:PermType2 object
set_project(ref_obj)

Set project for alias-ip.

Parameters:ref_obj – Project object
set_project_list(ref_obj_list)

Set project list for alias-ip.

Parameters:ref_obj_list – list of Project object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for alias-ip.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for alias-ip.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.AliasIpPool(name=None, parent_obj=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents alias-ip-pool configuration representation.

Child of:
VirtualNetwork object OR
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of AliasIp objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    alias ip is a ip that can be assigned to virtual-machine-interface(VMI), By doing so VMI can now be

    part of the alias ip network. packets originating with alias-ip as the source-ip belongs to alias-

    ip-network

References to:

Referred by:
display_name

Get display-name for alias-ip-pool.

Returns:xsd:string object
dump()

Display alias-ip-pool object in compact form.

get_fq_name()

Return FQN of alias-ip-pool in list form.

get_fq_name_str()

Return FQN of alias-ip-pool as colon delimited string.

get_parent_fq_name()

Return FQN of alias-ip-pool’s parent in list form.

get_parent_fq_name_str()

Return FQN of alias-ip-pool’s parent as colon delimted string.

get_project_back_refs()

Return list of all projects using this alias-ip-pool

get_type()

Return object type (alias-ip-pool).

id_perms

Get id-perms for alias-ip-pool.

Returns:IdPermsType object
perms2

Get perms2 for alias-ip-pool.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.AnalyticsNode(name=None, parent_obj=None, analytics_node_ip_address=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents analytics-node configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • analytics_node_ip_address

    Type: string, one-of xsd:string

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Ip address of the analytics node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

analytics_node_ip_address

Get analytics-node-ip-address for analytics-node.

Returns:IpAddressType object
display_name

Get display-name for analytics-node.

Returns:xsd:string object
dump()

Display analytics-node object in compact form.

get_fq_name()

Return FQN of analytics-node in list form.

get_fq_name_str()

Return FQN of analytics-node as colon delimited string.

get_parent_fq_name()

Return FQN of analytics-node’s parent in list form.

get_parent_fq_name_str()

Return FQN of analytics-node’s parent as colon delimted string.

get_type()

Return object type (analytics-node).

id_perms

Get id-perms for analytics-node.

Returns:IdPermsType object
perms2

Get perms2 for analytics-node.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.ApiAccessList(name=None, parent_obj=None, api_access_list_entries=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents api-access-list configuration representation.

Child of:
Domain object OR Project object OR GlobalSystemConfig object OR
Properties:
  • api_access_list_entries

    Type: RbacRuleEntriesType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of rules e.g network.* => admin:CRUD (admin can perform all ops on networks).

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

api_access_list_entries

Get api-access-list-entries for api-access-list.

Returns:RbacRuleEntriesType object
display_name

Get display-name for api-access-list.

Returns:xsd:string object
dump()

Display api-access-list object in compact form.

get_fq_name()

Return FQN of api-access-list in list form.

get_fq_name_str()

Return FQN of api-access-list as colon delimited string.

get_parent_fq_name()

Return FQN of api-access-list’s parent in list form.

get_parent_fq_name_str()

Return FQN of api-access-list’s parent as colon delimted string.

get_type()

Return object type (api-access-list).

id_perms

Get id-perms for api-access-list.

Returns:IdPermsType object
perms2

Get perms2 for api-access-list.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.BgpAsAService(name=None, parent_obj=None, autonomous_system=None, bgpaas_ip_address=None, bgpaas_session_attributes=None, bgpaas_ipv4_mapped_ipv6_nexthop=None, bgpaas_suppress_route_advertisement=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents bgp-as-a-service configuration representation.

Child of:
Project object OR
Properties:
  • autonomous_system

    Type: int, within [1, 65534]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    16 bit BGP Autonomous System number for the cluster.

  • bgpaas_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Ip address of the BGP peer.

  • bgpaas_session_attributes

    Type: BgpSessionAttributes

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    BGP peering session attributes.

  • bgpaas_ipv4_mapped_ipv6_nexthop

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    True when client bgp implementation expects to receive a ipv4-mapped ipv6 address (as opposed to

    regular ipv6 address) as the bgp nexthop for ipv6 routes.

  • bgpaas_suppress_route_advertisement

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    True when server should not advertise any routes to the client i.e. the client has static routes

    (typically a default) configured.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachineInterface objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to VMI on which BGPaaS BGP peering will happen.

  • list of BgpRouter objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to internal BGP peer object automatically generated by the system.

Referred by:

add_bgp_router(ref_obj)

Add bgp-router to bgp-as-a-service.

Parameters:ref_obj – BgpRouter object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to bgp-as-a-service.

Parameters:ref_obj – VirtualMachineInterface object
autonomous_system

Get autonomous-system for bgp-as-a-service.

Returns:AutonomousSystemType object
bgpaas_ip_address

Get bgpaas-ip-address for bgp-as-a-service.

Returns:IpAddressType object
bgpaas_ipv4_mapped_ipv6_nexthop

Get bgpaas-ipv4-mapped-ipv6-nexthop for bgp-as-a-service.

Returns:xsd:boolean object
bgpaas_session_attributes

Get bgpaas-session-attributes for bgp-as-a-service.

Returns:BgpSessionAttributes object
bgpaas_suppress_route_advertisement

Get bgpaas-suppress-route-advertisement for bgp-as-a-service.

Returns:xsd:boolean object
display_name

Get display-name for bgp-as-a-service.

Returns:xsd:string object
dump()

Display bgp-as-a-service object in compact form.

get_bgp_router_refs()

Return bgp-router list for bgp-as-a-service.

Returns:list of <BgpRouter>
get_fq_name()

Return FQN of bgp-as-a-service in list form.

get_fq_name_str()

Return FQN of bgp-as-a-service as colon delimited string.

get_parent_fq_name()

Return FQN of bgp-as-a-service’s parent in list form.

get_parent_fq_name_str()

Return FQN of bgp-as-a-service’s parent as colon delimted string.

get_type()

Return object type (bgp-as-a-service).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for bgp-as-a-service.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for bgp-as-a-service.

Returns:IdPermsType object
perms2

Get perms2 for bgp-as-a-service.

Returns:PermType2 object
set_bgp_router(ref_obj)

Set bgp-router for bgp-as-a-service.

Parameters:ref_obj – BgpRouter object
set_bgp_router_list(ref_obj_list)

Set bgp-router list for bgp-as-a-service.

Parameters:ref_obj_list – list of BgpRouter object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for bgp-as-a-service.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for bgp-as-a-service.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.BgpRouter(name=None, parent_obj=None, bgp_router_parameters=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents bgp-router configuration representation.

Child of:
RoutingInstance object OR
Properties:
  • bgp_router_parameters

    Type: BgpRouterParams

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    BGP router configuration parameters like ip address, AS number, hold time etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (BgpRouter object, BgpPeeringAttributes attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    References to peer BGP router, property of the reference has BGP peering attributes.

Referred by:
add_bgp_router(ref_obj, ref_data)

Add bgp-router to bgp-router.

Parameters:
  • ref_obj – BgpRouter object
  • ref_data – BgpPeeringAttributes object
bgp_router_parameters

Get bgp-router-parameters for bgp-router.

Returns:BgpRouterParams object
display_name

Get display-name for bgp-router.

Returns:xsd:string object
dump()

Display bgp-router object in compact form.

get_bgp_as_a_service_back_refs()

Return list of all bgp-as-a-services using this bgp-router

get_bgp_router_back_refs()

Return list of all bgp-routers using this bgp-router

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_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_type()

Return object type (bgp-router).

id_perms

Get id-perms for bgp-router.

Returns:IdPermsType object
perms2

Get perms2 for bgp-router.

Returns:PermType2 object
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
class vnc_cfg_api_server.gen.resource_common.ConfigNode(name=None, parent_obj=None, config_node_ip_address=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents config-node configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • config_node_ip_address

    Type: string, one-of xsd:string

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Ip address of the config node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

config_node_ip_address

Get config-node-ip-address for config-node.

Returns:IpAddressType object
display_name

Get display-name for config-node.

Returns:xsd:string object
dump()

Display config-node object in compact form.

get_fq_name()

Return FQN of config-node in list form.

get_fq_name_str()

Return FQN of config-node as colon delimited string.

get_parent_fq_name()

Return FQN of config-node’s parent in list form.

get_parent_fq_name_str()

Return FQN of config-node’s parent as colon delimted string.

get_type()

Return object type (config-node).

id_perms

Get id-perms for config-node.

Returns:IdPermsType object
perms2

Get perms2 for config-node.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.ConfigRoot(name=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents config-root configuration representation.

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of GlobalSystemConfig objects

    Created By: User (required)

    Operations Allowed: R

    Description:

    Global system config is object where all global system configuration is present.

  • list of Domain objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Domain is authentication namespace, a collection of projects.

References to:

Referred by:

display_name

Get display-name for config-root.

Returns:xsd:string object
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_type()

Return object type (config-root).

id_perms

Get id-perms for config-root.

Returns:IdPermsType object
perms2

Get perms2 for config-root.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.CustomerAttachment(name=None, attachment_address=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents customer-attachment configuration representation.

Properties:
  • attachment_address

    Type: AttachmentAddressType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Not in Use.

  • list of FloatingIp objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Not in Use.

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
attachment_address

Get attachment-address for customer-attachment.

Returns:AttachmentAddressType object
display_name

Get display-name for customer-attachment.

Returns:xsd:string object
dump()

Display customer-attachment object in compact form.

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_type()

Return object type (customer-attachment).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for customer-attachment.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for customer-attachment.

Returns:IdPermsType object
perms2

Get perms2 for customer-attachment.

Returns:PermType2 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_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.DatabaseNode(name=None, parent_obj=None, database_node_ip_address=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents database-node configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • database_node_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Ip address of the database node, set while provisioning.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

database_node_ip_address

Get database-node-ip-address for database-node.

Returns:IpAddressType object
display_name

Get display-name for database-node.

Returns:xsd:string object
dump()

Display database-node object in compact form.

get_fq_name()

Return FQN of database-node in list form.

get_fq_name_str()

Return FQN of database-node as colon delimited string.

get_parent_fq_name()

Return FQN of database-node’s parent in list form.

get_parent_fq_name_str()

Return FQN of database-node’s parent as colon delimted string.

get_type()

Return object type (database-node).

id_perms

Get id-perms for database-node.

Returns:IdPermsType object
perms2

Get perms2 for database-node.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.DiscoveryServiceAssignment(name=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents discovery-service-assignment configuration representation.

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of DsaRule objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Discovery service rule for assigning subscriber to publisher. (set of subscriber) can be assigned to

    (set of publisher).

References to:

Referred by:

display_name

Get display-name for discovery-service-assignment.

Returns:xsd:string object
dump()

Display discovery-service-assignment object in compact form.

get_fq_name()

Return FQN of discovery-service-assignment in list form.

get_fq_name_str()

Return FQN of discovery-service-assignment as colon delimited string.

get_type()

Return object type (discovery-service-assignment).

id_perms

Get id-perms for discovery-service-assignment.

Returns:IdPermsType object
perms2

Get perms2 for discovery-service-assignment.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.Domain(name=None, parent_obj=None, domain_limits=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents domain configuration representation.

Child of:
ConfigRoot object OR
Properties:
  • domain_limits

    Type: DomainLimitsType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Domain level Qouta, not currently implemented

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of Project objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Project represent one instance of application or tenant.

  • list of Namespace objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Namespace is unique networking namespace within this domain. If namespace is not present then

    default namespace of default project is used.

  • list of ServiceTemplate objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service templete defines how a service may be deployed in the network. Service instance is

    instantiated from config in service templete.

  • list of VirtualDns objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual DNS server is DNS as service for tenants. It is inbound DNS servce for virtual machines in

    this project. DNS requests by end points inside this project/IPAM are served by this DNS server

    rules.

  • list of ApiAccessList objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    API access list is list of rules that define role based access to each API and its properties at

    doamin level.

References to:

Referred by:

display_name

Get display-name for domain.

Returns:xsd:string object
domain_limits

Get domain-limits for domain.

Returns:DomainLimitsType object
dump()

Display domain object in compact form.

get_fq_name()

Return FQN of domain in list form.

get_fq_name_str()

Return FQN of domain as colon delimited string.

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).

id_perms

Get id-perms for domain.

Returns:IdPermsType object
perms2

Get perms2 for domain.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.DsaRule(name=None, parent_obj=None, dsa_rule_entry=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents dsa-rule configuration representation.

Child of:
DiscoveryServiceAssignment object OR
Properties:
  • dsa_rule_entry

    Type: DiscoveryServiceAssignmentType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    rule entry defining pubisher set and subscriber set.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

display_name

Get display-name for dsa-rule.

Returns:xsd:string object
dsa_rule_entry

Get dsa-rule-entry for dsa-rule.

Returns:DiscoveryServiceAssignmentType object
dump()

Display dsa-rule object in compact form.

get_fq_name()

Return FQN of dsa-rule in list form.

get_fq_name_str()

Return FQN of dsa-rule as colon delimited string.

get_parent_fq_name()

Return FQN of dsa-rule’s parent in list form.

get_parent_fq_name_str()

Return FQN of dsa-rule’s parent as colon delimted string.

get_type()

Return object type (dsa-rule).

id_perms

Get id-perms for dsa-rule.

Returns:IdPermsType object
perms2

Get perms2 for dsa-rule.

Returns:PermType2 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, floating_ip_fixed_ip_address=None, floating_ip_address_family=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents floating-ip configuration representation.

Child of:
FloatingIpPool object OR
Properties:
  • floating_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CR

    Description:

    Floating ip address.

  • floating_ip_is_virtual_ip

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This floating ip is used as virtual ip (VIP) in case of LBaaS.

  • floating_ip_fixed_ip_address

    Type: string, one-of xsd:string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This floating is tracking given fixed ip of the interface. The given fixed ip is used in 1:1 NAT.

  • floating_ip_address_family

    Type: string, one-of [u’v4’, u’v6’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip address family of the floating ip, IpV4 or IpV6

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of Project objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to project is which this floating ip was allocated.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual machine interface to which this floating ip is attached.

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
display_name

Get display-name for floating-ip.

Returns:xsd:string object
dump()

Display floating-ip object in compact form.

floating_ip_address

Get floating-ip-address for floating-ip.

Returns:IpAddressType object
floating_ip_address_family

Get floating-ip-address-family for floating-ip.

Returns:IpAddressFamilyType object
floating_ip_fixed_ip_address

Get floating-ip-fixed-ip-address for floating-ip.

Returns:IpAddressType object
floating_ip_is_virtual_ip

Get floating-ip-is-virtual-ip for floating-ip.

Returns:xsd:boolean object
get_customer_attachment_back_refs()

Return list of all customer-attachments 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_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>
id_perms

Get id-perms for floating-ip.

Returns:IdPermsType object
perms2

Get perms2 for floating-ip.

Returns:PermType2 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, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents floating-ip-pool configuration representation.

Child of:
VirtualNetwork object OR
Properties:
  • floating_ip_pool_prefixes

    Type: FloatingIpPoolType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of ip prefixes that restrict foating ip allocation from the corresponding virtual network.(Not

    yet implemented).

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of FloatingIp objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Floating ip is a ip that can be assigned to (virtual machine interface(VMI), ip), By doing so VMI

    can no be part of the floating ip network and floating ip is used as one:one to NAT for doing so.

References to:

Referred by:
display_name

Get display-name for floating-ip-pool.

Returns:xsd:string object
dump()

Display floating-ip-pool object in compact form.

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_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).

id_perms

Get id-perms for floating-ip-pool.

Returns:IdPermsType object
perms2

Get perms2 for floating-ip-pool.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.ForwardingClass(name=None, parent_obj=None, forwarding_class_id=None, forwarding_class_dscp=None, forwarding_class_vlan_priority=None, forwarding_class_mpls_exp=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents forwarding-class configuration representation.

Child of:
GlobalQosConfig object OR
Properties:
  • forwarding_class_id

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Unique ID for this forwarding class.

  • forwarding_class_dscp

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    DSCP value to be written on outgoing packet for this forwarding-class.

  • forwarding_class_vlan_priority

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    802.1p value to be written on outgoing packet for this forwarding-class.

  • forwarding_class_mpls_exp

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    MPLS exp value to be written on outgoing packet for this forwarding-class.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of QosQueue objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Qos queue to be used for this forwarding class.

Referred by:

add_qos_queue(ref_obj)

Add qos-queue to forwarding-class.

Parameters:ref_obj – QosQueue object
display_name

Get display-name for forwarding-class.

Returns:xsd:string object
dump()

Display forwarding-class object in compact form.

forwarding_class_dscp

Get forwarding-class-dscp for forwarding-class.

Returns:xsd:integer object
forwarding_class_id

Get forwarding-class-id for forwarding-class.

Returns:xsd:integer object
forwarding_class_mpls_exp

Get forwarding-class-mpls-exp for forwarding-class.

Returns:xsd:integer object
forwarding_class_vlan_priority

Get forwarding-class-vlan-priority for forwarding-class.

Returns:xsd:integer object
get_fq_name()

Return FQN of forwarding-class in list form.

get_fq_name_str()

Return FQN of forwarding-class as colon delimited string.

get_parent_fq_name()

Return FQN of forwarding-class’s parent in list form.

get_parent_fq_name_str()

Return FQN of forwarding-class’s parent as colon delimted string.

get_qos_queue_refs()

Return qos-queue list for forwarding-class.

Returns:list of <QosQueue>
get_type()

Return object type (forwarding-class).

id_perms

Get id-perms for forwarding-class.

Returns:IdPermsType object
perms2

Get perms2 for forwarding-class.

Returns:PermType2 object
set_qos_queue(ref_obj)

Set qos-queue for forwarding-class.

Parameters:ref_obj – QosQueue object
set_qos_queue_list(ref_obj_list)

Set qos-queue list for forwarding-class.

Parameters:ref_obj_list – list of QosQueue object
class vnc_cfg_api_server.gen.resource_common.GlobalQosConfig(name=None, parent_obj=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents global-qos-config configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of QosConfig objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Global system QoS config for vhost and fabric traffic .

  • list of ForwardingClass objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Link to global-qos config.

  • list of QosQueue objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    QOS queue config object in this project.

References to:

Referred by:

display_name

Get display-name for global-qos-config.

Returns:xsd:string object
dump()

Display global-qos-config object in compact form.

get_fq_name()

Return FQN of global-qos-config in list form.

get_fq_name_str()

Return FQN of global-qos-config as colon delimited string.

get_parent_fq_name()

Return FQN of global-qos-config’s parent in list form.

get_parent_fq_name_str()

Return FQN of global-qos-config’s parent as colon delimted string.

get_type()

Return object type (global-qos-config).

id_perms

Get id-perms for global-qos-config.

Returns:IdPermsType object
perms2

Get perms2 for global-qos-config.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.GlobalSystemConfig(name=None, parent_obj=None, autonomous_system=None, config_version=None, graceful_restart_params=None, plugin_tuning=None, ibgp_auto_mesh=None, ip_fabric_subnets=None, alarm_enable=None, user_defined_counter=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents global-system-config configuration representation.

Child of:
ConfigRoot object OR
Properties:
  • autonomous_system

    Type: int, within [1, 65534]

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    16 bit BGP Autonomous System number for the cluster.

  • config_version

    Type: string

    Created By: System

    Operations Allowed: R

    Description:

    Version of OpenContrail software that generated this config.

  • graceful_restart_params

    Type: GracefulRestartType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Graceful Restart parameters

  • plugin_tuning

    Type: PluginProperties

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.

  • ibgp_auto_mesh

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    When true, system will automatically create BGP peering mesh with all control-nodes that have same

    BGP AS number as global AS number.

  • ip_fabric_subnets

    Type: SubnetListType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of all subnets in which vrouter ip address exist. Used by Device manager to configure dynamic

    GRE tunnels on the SDN gateway.

  • alarm_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Flag to enable/disable alarms configured under global-system-config. True, if not set.

  • user_defined_counter

    Type: UserDefinedCounterList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    counter name and patterns

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of GlobalVrouterConfig objects

    Created By: User (required)

    Operations Allowed: R

    Description:

    Global vrouter config is object where all global vrouter config is present.

  • list of GlobalQosConfig objects

    Created By: User (required)

    Operations Allowed: R

    Description:

    Global QoS system config is object where all global system QoS configuration is present.

  • list of PhysicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Physical router object represent any physical device that participates in virtual networking, like

    routers, switches, servers, firewalls etc.

  • list of VirtualRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual router is packet forwarding system on devices such as compute nodes(servers), TOR(s),

    routers.

  • list of ConfigNode objects

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Config node is object representing a logical node in system which serves config API.

  • list of AnalyticsNode objects

    Created By: User (admin-only)

    Operations Allowed: CRUD

    Description:

    Analytics node is object representing a logical node in system which serves operational API and

    analytics collector.

  • list of DatabaseNode objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Database node is object representing a logical node in system which host Cassendra DB and Zookeeper.

  • list of ServiceApplianceSet objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service appliance set is the collection of service appliances.

    This collection is used as a provider in loadbalancer pool config.

    Algorithm to distribute/choose one appliance over other can be built while creating loadbalancer

    pool.

    By default, system will create service-appliance-set with name “opencontrail”.

    This is the default loadbalancer provider for pools in Contrail.

    This provider is based on “ha-proxy”.Service appliance set has following attribute -

    Driver to load for provisioning the appliance

    Service appliance properties - HA mode.

  • list of ApiAccessList objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Global API access list applicable to all domain and projects

  • list of Alarm objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of alarms that are applicable to objects anchored under global-system-config.

References to:
  • list of BgpRouter objects

    Created By: User (required)

    Operations Allowed: R

    Description:

    List of references to all bgp routers in systems.

Referred by:

add_bgp_router(ref_obj)

Add bgp-router to global-system-config.

Parameters:ref_obj – BgpRouter object
alarm_enable

Get alarm-enable for global-system-config.

Returns:xsd:boolean object
autonomous_system

Get autonomous-system for global-system-config.

Returns:AutonomousSystemType object
config_version

Get config-version for global-system-config.

Returns:xsd:string object
display_name

Get display-name for global-system-config.

Returns:xsd:string object
dump()

Display global-system-config object in compact form.

get_bgp_router_refs()

Return bgp-router list for global-system-config.

Returns:list of <BgpRouter>
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_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).

graceful_restart_params

Get graceful-restart-params for global-system-config.

Returns:GracefulRestartType object
ibgp_auto_mesh

Get ibgp-auto-mesh for global-system-config.

Returns:xsd:boolean object
id_perms

Get id-perms for global-system-config.

Returns:IdPermsType object
ip_fabric_subnets

Get ip-fabric-subnets for global-system-config.

Returns:SubnetListType object
perms2

Get perms2 for global-system-config.

Returns:PermType2 object
plugin_tuning

Get plugin-tuning for global-system-config.

Returns:PluginProperties 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
user_defined_counter

Get user-defined-counter for global-system-config.

Returns:UserDefinedCounterList object
class vnc_cfg_api_server.gen.resource_common.GlobalVrouterConfig(name=None, parent_obj=None, ecmp_hashing_include_fields=None, linklocal_services=None, encapsulation_priorities=None, vxlan_network_identifier_mode=None, flow_export_rate=None, flow_aging_timeout_list=None, forwarding_mode=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents global-vrouter-config configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • ecmp_hashing_include_fields

    Type: EcmpHashingIncludeFields

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    ECMP hashing config at global level.

  • linklocal_services

    Type: LinklocalServicesTypes

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Global services provided on link local subnet to the virtual machines.

  • encapsulation_priorities

    Type: EncapsulationPrioritiesType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ordered list of enapsulations that vrouter will use in priority order.

  • vxlan_network_identifier_mode

    Type: string, one-of [u’configured’, u’automatic’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Method of allocation of VxLAN VNI(s). Set at provision time and cannot be changed.

    configured = VxLAN VNI is given by user when virtual network is configured.

    automatic = System will allocate VxLAN VNI automatically.

  • flow_export_rate

    Type: int

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Flow export rate is global config, rate at which each vrouter will sample and export flow records to

    analytics

  • flow_aging_timeout_list

    Type: FlowAgingTimeoutList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Flow aging timeout per application (protocol, port) list.

  • forwarding_mode

    Type: string, one-of [u’l2_l3’, u’l2’, u’l3’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Packet forwarding mode for this system L2-only, L3-only OR L2-L3. L2-L3 is default.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

display_name

Get display-name for global-vrouter-config.

Returns:xsd:string object
dump()

Display global-vrouter-config object in compact form.

ecmp_hashing_include_fields

Get ecmp-hashing-include-fields for global-vrouter-config.

Returns:EcmpHashingIncludeFields object
encapsulation_priorities

Get encapsulation-priorities for global-vrouter-config.

Returns:EncapsulationPrioritiesType object
flow_aging_timeout_list

Get flow-aging-timeout-list for global-vrouter-config.

Returns:FlowAgingTimeoutList object
flow_export_rate

Get flow-export-rate for global-vrouter-config.

Returns:xsd:integer object
forwarding_mode

Get forwarding-mode for global-vrouter-config.

Returns:ForwardingModeType 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_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).

id_perms

Get id-perms for global-vrouter-config.

Returns:IdPermsType object
linklocal_services

Get linklocal-services for global-vrouter-config.

Returns:LinklocalServicesTypes object
perms2

Get perms2 for global-vrouter-config.

Returns:PermType2 object
vxlan_network_identifier_mode

Get vxlan-network-identifier-mode for global-vrouter-config.

Returns:VxlanNetworkIdentifierModeType object
class vnc_cfg_api_server.gen.resource_common.InstanceIp(name=None, instance_ip_address=None, instance_ip_family=None, instance_ip_mode=None, secondary_ip_tracking_ip=None, subnet_uuid=None, instance_ip_secondary=False, instance_ip_local_ip=False, service_instance_ip=False, service_health_check_ip=False, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents instance-ip configuration representation.

Properties:
  • instance_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Ip address value for instance ip.

  • instance_ip_family

    Type: string, one-of [u’v4’, u’v6’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip address family for instance ip, IPv4(v4) or IPv6(v6).

  • instance_ip_mode

    Type: string, one-of [u’active-active’, u’active-standby’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Ip address HA mode in case this instance ip is used in more than one interface, active-Active or

    active-Standby.

  • secondary_ip_tracking_ip

    Type: SubnetType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    When this instance ip is secondary ip, it can track activeness of another ip.

  • subnet_uuid

    Type: string

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    This instance ip was allocated from this Subnet(UUID).

  • instance_ip_secondary

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This instance ip is secondary ip of the interface.

  • instance_ip_local_ip

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This instance ip is local to compute and will not be exported to other nodes.

  • service_instance_ip

    Type: bool

    Created By: System

    Operations Allowed: CRUD

    Description:

    This instance ip is used as service chain next hop

  • service_health_check_ip

    Type: bool

    Created By: System

    Operations Allowed: CRUD

    Description:

    This instance ip is used as service health check source ip

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualNetwork objects

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Reference to virtual network of this instance ip.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual machine interface to which this instance ip is attached.

  • list of PhysicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This instance ip is used as IRB address on the referenced physical router (e.g.MX), In case of OVSDB

    TOR usecase this address will be used as default gateway for Host behind the TOR.

Referred by:
add_physical_router(ref_obj)

Add physical-router to instance-ip.

Parameters:ref_obj – PhysicalRouter object
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
display_name

Get display-name for instance-ip.

Returns:xsd:string 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_physical_router_refs()

Return physical-router list for instance-ip.

Returns:list of <PhysicalRouter>
get_service_instance_back_refs()

Return list of all service-instances using this instance-ip

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>
id_perms

Get id-perms for instance-ip.

Returns:IdPermsType object
instance_ip_address

Get instance-ip-address for instance-ip.

Returns:IpAddressType object
instance_ip_family

Get instance-ip-family for instance-ip.

Returns:IpAddressFamilyType object
instance_ip_local_ip

Get instance-ip-local-ip for instance-ip.

Returns:xsd:boolean object
instance_ip_mode

Get instance-ip-mode for instance-ip.

Returns:AddressMode object
instance_ip_secondary

Get instance-ip-secondary for instance-ip.

Returns:xsd:boolean object
perms2

Get perms2 for instance-ip.

Returns:PermType2 object
secondary_ip_tracking_ip

Get secondary-ip-tracking-ip for instance-ip.

Returns:SubnetType object
service_health_check_ip

Get service-health-check-ip for instance-ip.

Returns:xsd:boolean object
service_instance_ip

Get service-instance-ip for instance-ip.

Returns:xsd:boolean object
set_physical_router(ref_obj)

Set physical-router for instance-ip.

Parameters:ref_obj – PhysicalRouter object
set_physical_router_list(ref_obj_list)

Set physical-router list for instance-ip.

Parameters:ref_obj_list – list of PhysicalRouter 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
subnet_uuid

Get subnet-uuid for instance-ip.

Returns:xsd:string object
class vnc_cfg_api_server.gen.resource_common.InterfaceRouteTable(name=None, parent_obj=None, interface_route_table_routes=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents interface-route-table configuration representation.

Child of:
Project object OR
Properties:
  • interface_route_table_routes

    Type: RouteTableType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Interface route table used same structure as route table, however the next hop field is irrelevent.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (ServiceInstance object, ServiceInterfaceTag attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to interface route table attached to (service instance, interface), This is used to add

    interface static routes to service instance interface.

Referred by:
add_service_instance(ref_obj, ref_data)

Add service-instance to interface-route-table.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
display_name

Get display-name for interface-route-table.

Returns:xsd:string object
dump()

Display interface-route-table object in compact form.

get_fq_name()

Return FQN of interface-route-table in list form.

get_fq_name_str()

Return FQN of interface-route-table as colon delimited string.

get_parent_fq_name()

Return FQN of interface-route-table’s parent in list form.

get_parent_fq_name_str()

Return FQN of interface-route-table’s parent as colon delimted string.

get_service_instance_refs()

Return service-instance list for interface-route-table.

Returns:list of tuple <ServiceInstance, ServiceInterfaceTag>
get_type()

Return object type (interface-route-table).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this interface-route-table

id_perms

Get id-perms for interface-route-table.

Returns:IdPermsType object
interface_route_table_routes

Get interface-route-table-routes for interface-route-table.

Returns:RouteTableType object
perms2

Get perms2 for interface-route-table.

Returns:PermType2 object
set_service_instance(ref_obj, ref_data)

Set service-instance for interface-route-table.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
set_service_instance_list(ref_obj_list, ref_data_list)

Set service-instance list for interface-route-table.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of ServiceInterfaceTag object
class vnc_cfg_api_server.gen.resource_common.Loadbalancer(name=None, parent_obj=None, loadbalancer_properties=None, loadbalancer_provider=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer configuration representation.

Child of:
Project object OR
Properties:
  • loadbalancer_properties

    Type: LoadbalancerType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Loadbalance configuration like admin state, VIP, VIP subnet etc.

  • loadbalancer_provider

    Type: string

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    Provider field selects backend provider of the LBaaS, Cloudadmin could offere different levels of

    service like gold, silver, bronze. Provided by HA-proxy or various HW or SW appliances in the

    backend.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of ServiceInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to the service instance, created automatically by the system.

  • list of VirtualMachineInterface objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to the virtual machine interface for VIP, created automatically by the system.

Referred by:
add_service_instance(ref_obj)

Add service-instance to loadbalancer.

Parameters:ref_obj – ServiceInstance object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to loadbalancer.

Parameters:ref_obj – VirtualMachineInterface object
display_name

Get display-name for loadbalancer.

Returns:xsd:string object
dump()

Display loadbalancer object in compact form.

get_fq_name()

Return FQN of loadbalancer in list form.

get_fq_name_str()

Return FQN of loadbalancer as colon delimited string.

get_loadbalancer_listener_back_refs()

Return list of all loadbalancer-listeners using this loadbalancer

get_parent_fq_name()

Return FQN of loadbalancer’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer’s parent as colon delimted string.

get_service_instance_refs()

Return service-instance list for loadbalancer.

Returns:list of <ServiceInstance>
get_type()

Return object type (loadbalancer).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for loadbalancer.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for loadbalancer.

Returns:IdPermsType object
loadbalancer_properties

Get loadbalancer-properties for loadbalancer.

Returns:LoadbalancerType object
loadbalancer_provider

Get loadbalancer-provider for loadbalancer.

Returns:xsd:string object
perms2

Get perms2 for loadbalancer.

Returns:PermType2 object
set_service_instance(ref_obj)

Set service-instance for loadbalancer.

Parameters:ref_obj – ServiceInstance object
set_service_instance_list(ref_obj_list)

Set service-instance list for loadbalancer.

Parameters:ref_obj_list – list of ServiceInstance object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for loadbalancer.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for loadbalancer.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.LoadbalancerHealthmonitor(name=None, parent_obj=None, loadbalancer_healthmonitor_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer-healthmonitor configuration representation.

Child of:
Project object OR
Properties:
  • loadbalancer_healthmonitor_properties

    Type: LoadbalancerHealthmonitorType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Configuration parameters for health monitor like type, method, retries etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for loadbalancer-healthmonitor.

Returns:xsd:string object
dump()

Display loadbalancer-healthmonitor object in compact form.

get_fq_name()

Return FQN of loadbalancer-healthmonitor in list form.

get_fq_name_str()

Return FQN of loadbalancer-healthmonitor as colon delimited string.

get_loadbalancer_pool_back_refs()

Return list of all loadbalancer-pools using this loadbalancer-healthmonitor

get_parent_fq_name()

Return FQN of loadbalancer-healthmonitor’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer-healthmonitor’s parent as colon delimted string.

get_type()

Return object type (loadbalancer-healthmonitor).

id_perms

Get id-perms for loadbalancer-healthmonitor.

Returns:IdPermsType object
loadbalancer_healthmonitor_properties

Get loadbalancer-healthmonitor-properties for loadbalancer-healthmonitor.

Returns:LoadbalancerHealthmonitorType object
perms2

Get perms2 for loadbalancer-healthmonitor.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.LoadbalancerListener(name=None, parent_obj=None, loadbalancer_listener_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer-listener configuration representation.

Child of:
Project object OR
Properties:
  • loadbalancer_listener_properties

    Type: LoadbalancerListenerType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of Loadbalancer objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

Referred by:
add_loadbalancer(ref_obj)

Add loadbalancer to loadbalancer-listener.

Parameters:ref_obj – Loadbalancer object
display_name

Get display-name for loadbalancer-listener.

Returns:xsd:string object
dump()

Display loadbalancer-listener object in compact form.

get_fq_name()

Return FQN of loadbalancer-listener in list form.

get_fq_name_str()

Return FQN of loadbalancer-listener as colon delimited string.

get_loadbalancer_pool_back_refs()

Return list of all loadbalancer-pools using this loadbalancer-listener

get_loadbalancer_refs()

Return loadbalancer list for loadbalancer-listener.

Returns:list of <Loadbalancer>
get_parent_fq_name()

Return FQN of loadbalancer-listener’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer-listener’s parent as colon delimted string.

get_type()

Return object type (loadbalancer-listener).

id_perms

Get id-perms for loadbalancer-listener.

Returns:IdPermsType object
loadbalancer_listener_properties

Get loadbalancer-listener-properties for loadbalancer-listener.

Returns:LoadbalancerListenerType object
perms2

Get perms2 for loadbalancer-listener.

Returns:PermType2 object
set_loadbalancer(ref_obj)

Set loadbalancer for loadbalancer-listener.

Parameters:ref_obj – Loadbalancer object
set_loadbalancer_list(ref_obj_list)

Set loadbalancer list for loadbalancer-listener.

Parameters:ref_obj_list – list of Loadbalancer object
class vnc_cfg_api_server.gen.resource_common.LoadbalancerMember(name=None, parent_obj=None, loadbalancer_member_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer-member configuration representation.

Child of:
LoadbalancerPool object OR
Properties:
  • loadbalancer_member_properties

    Type: LoadbalancerMemberType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Member configuration like ip addres, destination port, weight etc.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:

display_name

Get display-name for loadbalancer-member.

Returns:xsd:string object
dump()

Display loadbalancer-member object in compact form.

get_fq_name()

Return FQN of loadbalancer-member in list form.

get_fq_name_str()

Return FQN of loadbalancer-member as colon delimited string.

get_parent_fq_name()

Return FQN of loadbalancer-member’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer-member’s parent as colon delimted string.

get_type()

Return object type (loadbalancer-member).

id_perms

Get id-perms for loadbalancer-member.

Returns:IdPermsType object
loadbalancer_member_properties

Get loadbalancer-member-properties for loadbalancer-member.

Returns:LoadbalancerMemberType object
perms2

Get perms2 for loadbalancer-member.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.LoadbalancerPool(name=None, parent_obj=None, loadbalancer_pool_properties=None, loadbalancer_pool_provider=None, loadbalancer_pool_custom_attributes=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents loadbalancer-pool configuration representation.

Child of:
Project object OR
Properties:
  • loadbalancer_pool_properties

    Type: LoadbalancerPoolType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Configuration for loabalancer pool like protocol, subnet, etc.

  • loadbalancer_pool_provider

    Type: string

    Created By: User (optional)

    Operations Allowed: CR

    Description:

    Provider field selects backend provider of the LBaaS, Cloudadmin could offere different levels of

    service like gold, silver, bronze. Provided by HA-proxy or various HW or SW appliances in the

    backend. Applicable to LBaaS V1

  • loadbalancer_pool_custom_attributes

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Custom loadbalancer config, opaque to the system. Specified as list of Key:Value pairs. Applicable

    to LBaaS V1.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of LoadbalancerMember objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Configuration object representing each member of load balancer pool.

References to:
  • list of ServiceInstance objects

    Created By: System

    Operations Allowed: CR

    Description:

    Reference to the service instance serving this pool, applicable to LBaaS V1.

  • list of VirtualMachineInterface objects

    Created By: System

    Operations Allowed: CR

    Description:

    Reference to the virtual machine interface reaching pool subnet, applicable to LBaaS V1.

  • list of LoadbalancerListener objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to loadbaancer listner served by this pool, applicabale to LBaaS V2.

  • list of ServiceApplianceSet objects

    Created By: System

    Operations Allowed: RReference to service-appliance-set where this loadbalancer-pool is hosted. Applicable to LBaaS V1.

    Description:

  • list of LoadbalancerHealthmonitor objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to loadbalancer healthmonitor that this pool uses.

Referred by:
add_loadbalancer_healthmonitor(ref_obj)

Add loadbalancer-healthmonitor to loadbalancer-pool.

Parameters:ref_obj – LoadbalancerHealthmonitor object
add_loadbalancer_listener(ref_obj)

Add loadbalancer-listener to loadbalancer-pool.

Parameters:ref_obj – LoadbalancerListener object
add_service_appliance_set(ref_obj)

Add service-appliance-set to loadbalancer-pool.

Parameters:ref_obj – ServiceApplianceSet object
add_service_instance(ref_obj)

Add service-instance to loadbalancer-pool.

Parameters:ref_obj – ServiceInstance object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to loadbalancer-pool.

Parameters:ref_obj – VirtualMachineInterface object
display_name

Get display-name for loadbalancer-pool.

Returns:xsd:string object
dump()

Display loadbalancer-pool object in compact form.

get_fq_name()

Return FQN of loadbalancer-pool in list form.

get_fq_name_str()

Return FQN of loadbalancer-pool as colon delimited string.

get_loadbalancer_healthmonitor_refs()

Return loadbalancer-healthmonitor list for loadbalancer-pool.

Returns:list of <LoadbalancerHealthmonitor>
get_loadbalancer_listener_refs()

Return loadbalancer-listener list for loadbalancer-pool.

Returns:list of <LoadbalancerListener>
get_parent_fq_name()

Return FQN of loadbalancer-pool’s parent in list form.

get_parent_fq_name_str()

Return FQN of loadbalancer-pool’s parent as colon delimted string.

get_service_appliance_set_refs()

Return service-appliance-set list for loadbalancer-pool.

Returns:list of <ServiceApplianceSet>
get_service_instance_refs()

Return service-instance list for loadbalancer-pool.

Returns:list of <ServiceInstance>
get_type()

Return object type (loadbalancer-pool).

get_virtual_ip_back_refs()

Return list of all virtual-ips using this loadbalancer-pool

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for loadbalancer-pool.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for loadbalancer-pool.

Returns:IdPermsType object
loadbalancer_pool_custom_attributes

Get loadbalancer-pool-custom-attributes for loadbalancer-pool.

Returns:KeyValuePairs object
loadbalancer_pool_properties

Get loadbalancer-pool-properties for loadbalancer-pool.

Returns:LoadbalancerPoolType object
loadbalancer_pool_provider

Get loadbalancer-pool-provider for loadbalancer-pool.

Returns:xsd:string object
perms2

Get perms2 for loadbalancer-pool.

Returns:PermType2 object
set_loadbalancer_healthmonitor(ref_obj)

Set loadbalancer-healthmonitor for loadbalancer-pool.

Parameters:ref_obj – LoadbalancerHealthmonitor object
set_loadbalancer_healthmonitor_list(ref_obj_list)

Set loadbalancer-healthmonitor list for loadbalancer-pool.

Parameters:ref_obj_list – list of LoadbalancerHealthmonitor object
set_loadbalancer_listener(ref_obj)

Set loadbalancer-listener for loadbalancer-pool.

Parameters:ref_obj – LoadbalancerListener object
set_loadbalancer_listener_list(ref_obj_list)

Set loadbalancer-listener list for loadbalancer-pool.

Parameters:ref_obj_list – list of LoadbalancerListener object
set_service_appliance_set(ref_obj)

Set service-appliance-set for loadbalancer-pool.

Parameters:ref_obj – ServiceApplianceSet object
set_service_appliance_set_list(ref_obj_list)

Set service-appliance-set list for loadbalancer-pool.

Parameters:ref_obj_list – list of ServiceApplianceSet object
set_service_instance(ref_obj)

Set service-instance for loadbalancer-pool.

Parameters:ref_obj – ServiceInstance object
set_service_instance_list(ref_obj_list)

Set service-instance list for loadbalancer-pool.

Parameters:ref_obj_list – list of ServiceInstance object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for loadbalancer-pool.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for loadbalancer-pool.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.LogicalInterface(name=None, parent_obj=None, logical_interface_vlan_tag=None, logical_interface_type=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents logical-interface configuration representation.

Child of:
PhysicalRouter object OR PhysicalInterface object OR
Properties:
  • logical_interface_vlan_tag

    Type: int

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    VLAN tag (.1Q) classifier for this logical interface.

  • logical_interface_type

    Type: string, one-of [u’l2’, u’l3’]

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Logical interface type can be L2 or L3.

    L2 - only L2 service is provided, MAC learning is supported.

    L3 - only L3 service is supported and MAC learning is not supported.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    References to virtual machine interfaces that represent end points that are reacheable by this

    logical interface.

Referred by:

add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to logical-interface.

Parameters:ref_obj – VirtualMachineInterface object
display_name

Get display-name for logical-interface.

Returns:xsd:string 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_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_type()

Return object type (logical-interface).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for logical-interface.

Returns:list of <VirtualMachineInterface>
id_perms

Get id-perms for logical-interface.

Returns:IdPermsType object
logical_interface_type

Get logical-interface-type for logical-interface.

Returns:LogicalInterfaceType object
logical_interface_vlan_tag

Get logical-interface-vlan-tag for logical-interface.

Returns:xsd:integer object
perms2

Get perms2 for logical-interface.

Returns:PermType2 object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for logical-interface.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for logical-interface.

Parameters:ref_obj_list – list of VirtualMachineInterface object
class vnc_cfg_api_server.gen.resource_common.LogicalRouter(name=None, parent_obj=None, configured_route_target_list=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents logical-router configuration representation.

Child of:
Project object OR
Properties:
  • configured_route_target_list

    Type: RouteTargetList

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of route targets that represent this logical router, all virtual networks connected to this

    logical router will have this as their route target list.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Refernce to the interface attached to this logical router. By attaching a interface to logical

    network all subnets in the virtual network of the interface has this router.

  • list of RouteTarget objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Route target that represent this logical router.

  • list of RouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the route table attached to this logical router. By attaching route table, system will

    create static routes with the route target only of route targets linked to this logical router

  • list of VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Refernce to virtual network used as external gateway for this logical network. This link will cause

    a SNAT being spwaned between all networks connected to logical router and external network.

  • list of ServiceInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Refernce to service instance doing SNAT functionality for external gateway.

Referred by:

add_route_table(ref_obj)

Add route-table to logical-router.

Parameters:ref_obj – RouteTable object
add_route_target(ref_obj)

Add route-target to logical-router.

Parameters:ref_obj – RouteTarget object
add_service_instance(ref_obj)

Add service-instance to logical-router.

Parameters:ref_obj – ServiceInstance object
add_virtual_machine_interface(ref_obj)

Add virtual-machine-interface to logical-router.

Parameters:ref_obj – VirtualMachineInterface object
add_virtual_network(ref_obj)

Add virtual-network to logical-router.

Parameters:ref_obj – VirtualNetwork object
configured_route_target_list

Get configured-route-target-list for logical-router.

Returns:RouteTargetList object
display_name

Get display-name for logical-router.

Returns:xsd:string object
dump()

Display logical-router object in compact form.

get_fq_name()

Return FQN of logical-router in list form.

get_fq_name_str()

Return FQN of logical-router as colon delimited string.

get_parent_fq_name()

Return FQN of logical-router’s parent in list form.

get_parent_fq_name_str()

Return FQN of logical-router’s parent as colon delimted string.

get_route_table_refs()

Return route-table list for logical-router.

Returns:list of <RouteTable>
get_route_target_refs()

Return route-target list for logical-router.

Returns:list of <RouteTarget>
get_service_instance_refs()

Return service-instance list for logical-router.

Returns:list of <ServiceInstance>
get_type()

Return object type (logical-router).

get_virtual_machine_interface_refs()

Return virtual-machine-interface list for logical-router.

Returns:list of <VirtualMachineInterface>
get_virtual_network_refs()

Return virtual-network list for logical-router.

Returns:list of <VirtualNetwork>
id_perms

Get id-perms for logical-router.

Returns:IdPermsType object
perms2

Get perms2 for logical-router.

Returns:PermType2 object
set_route_table(ref_obj)

Set route-table for logical-router.

Parameters:ref_obj – RouteTable object
set_route_table_list(ref_obj_list)

Set route-table list for logical-router.

Parameters:ref_obj_list – list of RouteTable object
set_route_target(ref_obj)

Set route-target for logical-router.

Parameters:ref_obj – RouteTarget object
set_route_target_list(ref_obj_list)

Set route-target list for logical-router.

Parameters:ref_obj_list – list of RouteTarget object
set_service_instance(ref_obj)

Set service-instance for logical-router.

Parameters:ref_obj – ServiceInstance object
set_service_instance_list(ref_obj_list)

Set service-instance list for logical-router.

Parameters:ref_obj_list – list of ServiceInstance object
set_virtual_machine_interface(ref_obj)

Set virtual-machine-interface for logical-router.

Parameters:ref_obj – VirtualMachineInterface object
set_virtual_machine_interface_list(ref_obj_list)

Set virtual-machine-interface list for logical-router.

Parameters:ref_obj_list – list of VirtualMachineInterface object
set_virtual_network(ref_obj)

Set virtual-network for logical-router.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for logical-router.

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, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents namespace configuration representation.

Child of:
Domain object OR
Properties:
  • namespace_cidr

    Type: SubnetType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    All networks in this namespace belong to this list of Prefixes. Not implemented.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for namespace.

Returns:xsd:string object
dump()

Display namespace object in compact form.

get_fq_name()

Return FQN of namespace in list form.

get_fq_name_str()

Return FQN of namespace as colon delimited string.

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).

id_perms

Get id-perms for namespace.

Returns:IdPermsType object
namespace_cidr

Get namespace-cidr for namespace.

Returns:SubnetType object
perms2

Get perms2 for namespace.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.NetworkIpam(name=None, parent_obj=None, network_ipam_mgmt=None, ipam_subnets=None, ipam_subnet_method=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents network-ipam configuration representation.

Child of:
Project object OR
Properties:
  • network_ipam_mgmt

    Type: IpamType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Network IP Address Management configuration.

  • ipam_subnets

    Type: IpamSubnets

    Created By: User (optional)

    Operations Allowed: CRD

    Description:

    List of subnets for this ipam.

  • ipam_subnet_method

    Type: string, one-of [u’user-defined-subnet’, u’flat-subnet’, u’auto-subnet’]

    Created By: User (optional)

    Operations Allowed: CRD

    Description:

    Subnet method configuration for ipam, user can configure user-defined, flat or auto.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualDns objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual DNS used by this IPAM.

Referred by:
add_virtual_DNS(ref_obj)

Add virtual-DNS to network-ipam.

Parameters:ref_obj – VirtualDns object
display_name

Get display-name for network-ipam.

Returns:xsd:string 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_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_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

id_perms

Get id-perms for network-ipam.

Returns:IdPermsType object
ipam_subnet_method

Get ipam-subnet-method for network-ipam.

Returns:SubnetMethodType object
ipam_subnets

Get ipam-subnets for network-ipam.

Returns:IpamSubnets object
network_ipam_mgmt

Get network-ipam-mgmt for network-ipam.

Returns:IpamType object
perms2

Get perms2 for network-ipam.

Returns:PermType2 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, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents network-policy configuration representation.

Child of:
Project object OR
Properties:
  • network_policy_entries

    Type: PolicyEntriesType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Network policy rule entries.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for network-policy.

Returns:xsd:string object
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_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_type()

Return object type (network-policy).

get_virtual_network_back_refs()

Return list of all virtual-networks using this network-policy

id_perms

Get id-perms for network-policy.

Returns:IdPermsType object
network_policy_entries

Get network-policy-entries for network-policy.

Returns:PolicyEntriesType object
perms2

Get perms2 for network-policy.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.PhysicalInterface(name=None, parent_obj=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents physical-interface configuration representation.

Child of:
PhysicalRouter object OR
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of LogicalInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Logical interfaces on physical interface on physical routers.

References to:
  • list of PhysicalInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to the other physical interface that is connected to this physical interface.

Referred by:
add_physical_interface(ref_obj)

Add physical-interface to physical-interface.

Parameters:ref_obj – PhysicalInterface object
display_name

Get display-name for physical-interface.

Returns:xsd:string object
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_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_interface_back_refs()

Return list of all physical-interfaces using this physical-interface

get_physical_interface_refs()

Return physical-interface list for physical-interface.

Returns:list of <PhysicalInterface>
get_service_appliance_back_refs()

Return list of all service-appliances using this physical-interface

get_type()

Return object type (physical-interface).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this physical-interface

id_perms

Get id-perms for physical-interface.

Returns:IdPermsType object
perms2

Get perms2 for physical-interface.

Returns:PermType2 object
set_physical_interface(ref_obj)

Set physical-interface for physical-interface.

Parameters:ref_obj – PhysicalInterface object
set_physical_interface_list(ref_obj_list)

Set physical-interface list for physical-interface.

Parameters:ref_obj_list – list of PhysicalInterface object
class vnc_cfg_api_server.gen.resource_common.PhysicalRouter(name=None, parent_obj=None, physical_router_management_ip=None, physical_router_dataplane_ip=None, physical_router_vendor_name=None, physical_router_product_name=None, physical_router_vnc_managed=None, physical_router_user_credentials=None, physical_router_snmp_credentials=None, physical_router_junos_service_ports=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents physical-router configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • physical_router_management_ip

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Management ip for this physical router. It is used by the device manager to perform netconf and by

    SNMP collector if enabled.

  • physical_router_dataplane_ip

    Type: string, one-of xsd:string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This is ip address in the ip-fabric(underlay) network that can be used in data palne by physical

    router. Usually it is the VTEP address in VxLAN for the TOR switch.

  • physical_router_vendor_name

    Type: string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Vendor name of the physical router (e.g juniper). Used by the device manager to select driver.

  • physical_router_product_name

    Type: string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Model name of the physical router (e.g juniper). Used by the device manager to select driver.

  • physical_router_vnc_managed

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    This physical router is enabled to be configured by device manager.

  • physical_router_user_credentials

    Type: UserCredentials

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Username and password for netconf to the physical router by device manager.

  • physical_router_snmp_credentials

    Type: SNMPCredentials

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    SNMP credentials for the physical router used by SNMP colloctor.

  • physical_router_junos_service_ports

    Type: JunosServicePorts

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Juniper JUNOS specific sevice interfaces name to perform services like NAT.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of PhysicalInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Physical interfaces on physical routers.

  • list of LogicalInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Logical interfaces on physical routers.

References to:
  • list of VirtualRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Referance to vrouter responsible for this physical router. Currently only pplicable for vrouters

    that are TOR agents.

  • list of BgpRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Referance to BGP peer representing this physical router.

  • list of VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to virtual network, whose VRF is present on this physical router, Applicable when only VRF

    is present with no physical interfaces from this physical vrouter. Generally used when using device

    manager and option A+B for this virtual network in L3VPN use case.

Referred by:
add_bgp_router(ref_obj)

Add bgp-router to physical-router.

Parameters:ref_obj – BgpRouter object
add_virtual_network(ref_obj)

Add virtual-network to physical-router.

Parameters:ref_obj – VirtualNetwork object
add_virtual_router(ref_obj)

Add virtual-router to physical-router.

Parameters:ref_obj – VirtualRouter object
display_name

Get display-name for physical-router.

Returns:xsd:string 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_instance_ip_back_refs()

Return list of all instance-ips using this physical-router

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).

get_virtual_network_refs()

Return virtual-network list for physical-router.

Returns:list of <VirtualNetwork>
get_virtual_router_refs()

Return virtual-router list for physical-router.

Returns:list of <VirtualRouter>
id_perms

Get id-perms for physical-router.

Returns:IdPermsType object
perms2

Get perms2 for physical-router.

Returns:PermType2 object
physical_router_dataplane_ip

Get physical-router-dataplane-ip for physical-router.

Returns:IpAddress object
physical_router_junos_service_ports

Get physical-router-junos-service-ports for physical-router.

Returns:JunosServicePorts object
physical_router_management_ip

Get physical-router-management-ip for physical-router.

Returns:IpAddress object
physical_router_product_name

Get physical-router-product-name for physical-router.

Returns:xsd:string object
physical_router_snmp_credentials

Get physical-router-snmp-credentials for physical-router.

Returns:SNMPCredentials object
physical_router_user_credentials

Get physical-router-user-credentials for physical-router.

Returns:UserCredentials object
physical_router_vendor_name

Get physical-router-vendor-name for physical-router.

Returns:xsd:string object
physical_router_vnc_managed

Get physical-router-vnc-managed for physical-router.

Returns:xsd:boolean object
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_virtual_network(ref_obj)

Set virtual-network for physical-router.

Parameters:ref_obj – VirtualNetwork object
set_virtual_network_list(ref_obj_list)

Set virtual-network list for physical-router.

Parameters:ref_obj_list – list of VirtualNetwork object
set_virtual_router(ref_obj)

Set virtual-router for physical-router.

Parameters:ref_obj – VirtualRouter object
set_virtual_router_list(ref_obj_list)

Set virtual-router list for physical-router.

Parameters:ref_obj_list – list of VirtualRouter object
class vnc_cfg_api_server.gen.resource_common.PortTuple(name=None, parent_obj=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents port-tuple configuration representation.

Child of:
ServiceInstance object OR
Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for port-tuple.

Returns:xsd:string object
dump()

Display port-tuple object in compact form.

get_fq_name()

Return FQN of port-tuple in list form.

get_fq_name_str()

Return FQN of port-tuple as colon delimited string.

get_parent_fq_name()

Return FQN of port-tuple’s parent in list form.

get_parent_fq_name_str()

Return FQN of port-tuple’s parent as colon delimted string.

get_type()

Return object type (port-tuple).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this port-tuple

id_perms

Get id-perms for port-tuple.

Returns:IdPermsType object
perms2

Get perms2 for port-tuple.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.Project(name=None, parent_obj=None, quota=None, alarm_enable=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents project configuration representation.

Child of:
Domain object OR
Properties:
  • quota

    Type: QuotaType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Max instances limits for various objects under project.

  • alarm_enable

    Type: bool

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Flag to enable/disable alarms configured under global-system-config. True, if not set.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of SecurityGroup objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Security Groups are set of state full access control rules attached to interfaces.It can be used to

    implement microsegmentation.

  • list of VirtualNetwork objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual network is collection of end points (interface or ip(s) or MAC(s)) that can talk to each

    other by default. It is collection of subnets connected by implicit router which default gateway in

    each subnet.

  • list of QosConfig objects

    Created By: User (optional)

    Operations Allowed: CRUDQOS configuration specifying marking and queueing value for various QoS values

    Description:

  • list of NetworkIpam objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    IP Address Management object that controls, ip allocation, DNS and DHCP

  • list of NetworkPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Network Policy is set access control rules that can be attached to virtual networks. Network ACL(s)

    and connectivity information is derived from Network policies that are attached to virtual networks.

  • list of VirtualMachineInterface objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual machine interface represent a interface(port) into virtual network. It may or may not have

    corresponding virtual machine. A virtual machine interface has atleast a MAC address and Ip address.

  • list of BgpAsAService objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    BGP as service object represents BGP peer in the virtual network that can participate in dynamic

    routing with implicit default gateway of the virtual network.

  • list of RoutingPolicy objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of references of child routing policy objects. automatically maintained by system.

  • list of RouteAggregate objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of references of child routing route aggregate objects. automatically maintained by system.

  • list of ServiceInstance objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service instance represents logical instance service used in the virtual world, e.g. firewall, load

    balancer etc. It can represent one or multiple virtual machines or physical devices. Many service

    instances can share a virtual machine or physical device.

  • list of ServiceHealthCheck objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service health check is a keepalive machenism for the virtual machine interface. Liveliness of the

    interface is determined based on configuration in the service health check. It is mainly designed

    for service instance interfaces. However it will work with any interface which present on contrail

    vrouter.

  • list of RouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Network route table is machinism of adding static routes in the virtual network

  • list of InterfaceRouteTable objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Interface route table is machanism to add static routes pointing to this interface.

  • list of LogicalRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Logical router is a machanism to connect multiple virtual network as they have been connected by a

    router.

  • list of ApiAccessList objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    API access list is list of rules that define role based access to each API and its properties at

    project level.

  • list of LoadbalancerPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Loadbalancer pool object represent set(pool) memeber servers which needs load balancing.

  • list of LoadbalancerHealthmonitor objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Health monitor objects is configuration to monitor health of individual pool members.

  • list of VirtualIp objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Virtual ip opject application(protocol, port). Applicable only to LBaaS V1

  • list of LoadbalancerListener objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Listener represents the application(protocol, port) to be load balanced.

  • list of Loadbalancer objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Loadbalancer object represents a LBaaS instance. One single Virtual IP and multiple (listeners,

    pools). Applicable to LBaaS V2.

  • list of Alarm objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of alarms that are applicable to objects anchored under the project.

References to:
  • list of (Namespace object, SubnetType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to network namespace of this project.

  • list of FloatingIpPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to floating ip pool in this project.

  • list of AliasIpPool objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to alias ip pool in this project.

Referred by:
add_alias_ip_pool(ref_obj)

Add alias-ip-pool to project.

Parameters:ref_obj – AliasIpPool object
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
alarm_enable

Get alarm-enable for project.

Returns:xsd:boolean object
display_name

Get display-name for project.

Returns:xsd:string object
dump()

Display project object in compact form.

get_alias_ip_back_refs()

Return list of all alias-ips using this project

get_alias_ip_pool_refs()

Return alias-ip-pool list for project.

Returns:list of <AliasIpPool>
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_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).

id_perms

Get id-perms for project.

Returns:IdPermsType object
perms2

Get perms2 for project.

Returns:PermType2 object
quota

Get quota for project.

Returns:QuotaType object
set_alias_ip_pool(ref_obj)

Set alias-ip-pool for project.

Parameters:ref_obj – AliasIpPool object
set_alias_ip_pool_list(ref_obj_list)

Set alias-ip-pool list for project.

Parameters:ref_obj_list – list of AliasIpPool object
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_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, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents provider-attachment configuration representation.

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of VirtualRouter objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Not in Use.

Referred by:

add_virtual_router(ref_obj)

Add virtual-router to provider-attachment.

Parameters:ref_obj – VirtualRouter object
display_name

Get display-name for provider-attachment.

Returns:xsd:string object
dump()

Display provider-attachment object in compact form.

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_type()

Return object type (provider-attachment).

get_virtual_router_refs()

Return virtual-router list for provider-attachment.

Returns:list of <VirtualRouter>
id_perms

Get id-perms for provider-attachment.

Returns:IdPermsType object
perms2

Get perms2 for provider-attachment.

Returns:PermType2 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.QosConfig(name=None, parent_obj=None, qos_config_type=None, dscp_entries=None, vlan_priority_entries=None, mpls_exp_entries=None, default_forwarding_class_id=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents qos-config configuration representation.

Child of:
GlobalQosConfig object OR Project object OR
Properties:
  • qos_config_type

    Type: string, one-of [u’vhost’, u’fabric’, u’project’]

    Created By: User (CRUD)

    Operations Allowed: SPECIFIES IF QOS-CONFIG IS FOR VHOST, FABRIC OR FOR PROJECT.

    Description:

  • dscp_entries

    Type: QosIdForwardingClassPairs

    Created By: User (CRUD)

    Operations Allowed: MAP OF DSCP MATCH CONDITION AND APPLICABLE FORWARDING CLASS FOR PACKET.

    Description:

  • vlan_priority_entries

    Type: QosIdForwardingClassPairs

    Created By: User (CRUD)

    Operations Allowed: MAP OF .1P PRIORITY CODE TO APPLICABLE FORWARDING CLASS FOR PACKET.

    Description:

  • mpls_exp_entries

    Type: QosIdForwardingClassPairs

    Created By: User (CRUD)

    Operations Allowed: MAP OF MPLS EXP VALUES TO APPLICABLE FORWARDING CLASS FOR PACKET.

    Description:

  • default_forwarding_class_id

    Type: int

    Created By: User (CRUD)

    Operations Allowed: DEFAULT FORWARDING CLASS USED FOR ALL NON-SPECIFIED QOS BITS

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
default_forwarding_class_id

Get default-forwarding-class-id for qos-config.

Returns:xsd:integer object
display_name

Get display-name for qos-config.

Returns:xsd:string object
dscp_entries

Get dscp-entries for qos-config.

Returns:QosIdForwardingClassPairs object
dump()

Display qos-config object in compact form.

get_fq_name()

Return FQN of qos-config in list form.

get_fq_name_str()

Return FQN of qos-config as colon delimited string.

get_parent_fq_name()

Return FQN of qos-config’s parent in list form.

get_parent_fq_name_str()

Return FQN of qos-config’s parent as colon delimted string.

get_type()

Return object type (qos-config).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this qos-config

get_virtual_network_back_refs()

Return list of all virtual-networks using this qos-config

id_perms

Get id-perms for qos-config.

Returns:IdPermsType object
mpls_exp_entries

Get mpls-exp-entries for qos-config.

Returns:QosIdForwardingClassPairs object
perms2

Get perms2 for qos-config.

Returns:PermType2 object
qos_config_type

Get qos-config-type for qos-config.

Returns:QosConfigType object
vlan_priority_entries

Get vlan-priority-entries for qos-config.

Returns:QosIdForwardingClassPairs object
class vnc_cfg_api_server.gen.resource_common.QosQueue(name=None, parent_obj=None, min_bandwidth=None, max_bandwidth=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents qos-queue configuration representation.

Child of:
GlobalQosConfig object OR
Properties:
  • min_bandwidth

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Minimum bandwidth for this queue.

  • max_bandwidth

    Type: int

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Maximum bandwidth for this queue.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for qos-queue.

Returns:xsd:string object
dump()

Display qos-queue object in compact form.

get_forwarding_class_back_refs()

Return list of all forwarding-classs using this qos-queue

get_fq_name()

Return FQN of qos-queue in list form.

get_fq_name_str()

Return FQN of qos-queue as colon delimited string.

get_parent_fq_name()

Return FQN of qos-queue’s parent in list form.

get_parent_fq_name_str()

Return FQN of qos-queue’s parent as colon delimted string.

get_type()

Return object type (qos-queue).

id_perms

Get id-perms for qos-queue.

Returns:IdPermsType object
max_bandwidth

Get max-bandwidth for qos-queue.

Returns:xsd:integer object
min_bandwidth

Get min-bandwidth for qos-queue.

Returns:xsd:integer object
perms2

Get perms2 for qos-queue.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.RouteAggregate(name=None, parent_obj=None, aggregate_route_entries=None, aggregate_route_nexthop=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents route-aggregate configuration representation.

Child of:
Project object OR
Properties:
  • aggregate_route_entries

    Type: RouteListType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of ip prefix (aggregate route prefix) for which aggregate route will be advertised. This

    aggregate route is advertised if a matching(longest prefix match) prefix is found.

  • aggregate_route_nexthop

    Type: string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Next for aggregate route that will be advertised.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (ServiceInstance object, ServiceInterfaceTag attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to route-aggregate policy attached to (service instance, interface).

  • list of RoutingInstance objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    Reference to internal routing instance object automatically generated by system.

Referred by:

add_routing_instance(ref_obj)

Add routing-instance to route-aggregate.

Parameters:ref_obj – RoutingInstance object
add_service_instance(ref_obj, ref_data)

Add service-instance to route-aggregate.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
aggregate_route_entries

Get aggregate-route-entries for route-aggregate.

Returns:RouteListType object
aggregate_route_nexthop

Get aggregate-route-nexthop for route-aggregate.

Returns:xsd:string object
display_name

Get display-name for route-aggregate.

Returns:xsd:string object
dump()

Display route-aggregate object in compact form.

get_fq_name()

Return FQN of route-aggregate in list form.

get_fq_name_str()

Return FQN of route-aggregate as colon delimited string.

get_parent_fq_name()

Return FQN of route-aggregate’s parent in list form.

get_parent_fq_name_str()

Return FQN of route-aggregate’s parent as colon delimted string.

get_routing_instance_refs()

Return routing-instance list for route-aggregate.

Returns:list of <RoutingInstance>
get_service_instance_refs()

Return service-instance list for route-aggregate.

Returns:list of tuple <ServiceInstance, ServiceInterfaceTag>
get_type()

Return object type (route-aggregate).

id_perms

Get id-perms for route-aggregate.

Returns:IdPermsType object
perms2

Get perms2 for route-aggregate.

Returns:PermType2 object
set_routing_instance(ref_obj)

Set routing-instance for route-aggregate.

Parameters:ref_obj – RoutingInstance object
set_routing_instance_list(ref_obj_list)

Set routing-instance list for route-aggregate.

Parameters:ref_obj_list – list of RoutingInstance object
set_service_instance(ref_obj, ref_data)

Set service-instance for route-aggregate.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
set_service_instance_list(ref_obj_list, ref_data_list)

Set service-instance list for route-aggregate.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of ServiceInterfaceTag object
class vnc_cfg_api_server.gen.resource_common.RouteTable(name=None, parent_obj=None, routes=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents route-table configuration representation.

Child of:
Project object OR
Properties:
  • routes

    Type: RouteTableType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Routes in the route table are configured in following way.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for route-table.

Returns:xsd:string object
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_logical_router_back_refs()

Return list of all logical-routers using this route-table

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_type()

Return object type (route-table).

get_virtual_network_back_refs()

Return list of all virtual-networks using this route-table

id_perms

Get id-perms for route-table.

Returns:IdPermsType object
perms2

Get perms2 for route-table.

Returns:PermType2 object
routes

Get routes for route-table.

Returns:RouteTableType object
class vnc_cfg_api_server.gen.resource_common.RouteTarget(name=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents route-target configuration representation.

Properties:
  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:

Referred by:
display_name

Get display-name for route-target.

Returns:xsd:string object
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_logical_router_back_refs()

Return list of all logical-routers using this route-target

get_routing_instance_back_refs()

Return list of all routing-instances using this route-target

get_type()

Return object type (route-target).

id_perms

Get id-perms for route-target.

Returns:IdPermsType object
perms2

Get perms2 for route-target.

Returns:PermType2 object
class vnc_cfg_api_server.gen.resource_common.RoutingInstance(name=None, parent_obj=None, service_chain_information=None, ipv6_service_chain_information=None, routing_instance_is_default=False, routing_instance_has_pnf=False, static_route_entries=None, default_ce_protocol=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents routing-instance configuration representation.

Child of:
VirtualNetwork object OR
Properties:
  • service_chain_information

    Type: ServiceChainInfo

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • ipv6_service_chain_information

    Type: ServiceChainInfo

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • routing_instance_is_default

    Type: bool

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • routing_instance_has_pnf

    Type: bool

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • static_route_entries

    Type: StaticRouteEntriesType

    Created By: System

    Operations Allowed: CRUD

    Description:

    Internal service chaining information, should not be modified.

  • default_ce_protocol

    Type: DefaultProtocolType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of BgpRouter objects

    Created By: User (optionalCRUD)

    Operations Allowed: BGP router object represent configuration of BGP peers. All the BGP peers involved in contrail system are under default routing instance of the default virtual network.

    Description:

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
default_ce_protocol

Get default-ce-protocol for routing-instance.

Returns:DefaultProtocolType object
display_name

Get display-name for routing-instance.

Returns:xsd:string object
dump()

Display routing-instance object in compact form.

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_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_aggregate_back_refs()

Return list of all route-aggregates using this routing-instance

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_routing_policy_back_refs()

Return list of all routing-policys using this routing-instance

get_type()

Return object type (routing-instance).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this routing-instance

id_perms

Get id-perms for routing-instance.

Returns:IdPermsType object
ipv6_service_chain_information

Get ipv6-service-chain-information for routing-instance.

Returns:ServiceChainInfo object
perms2

Get perms2 for routing-instance.

Returns:PermType2 object
routing_instance_has_pnf

Get routing-instance-has-pnf for routing-instance.

Returns:xsd:boolean object
routing_instance_is_default

Get routing-instance-is-default for routing-instance.

Returns:xsd:boolean object
service_chain_information

Get service-chain-information for routing-instance.

Returns:ServiceChainInfo 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
static_route_entries

Get static-route-entries for routing-instance.

Returns:StaticRouteEntriesType object
class vnc_cfg_api_server.gen.resource_common.RoutingPolicy(name=None, parent_obj=None, routing_policy_entries=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents routing-policy configuration representation.

Child of:
Project object OR
Properties:
  • routing_policy_entries

    Type: PolicyStatementType

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (ServiceInstance object, RoutingPolicyServiceInstanceType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to routing policy attached to (service instance, interface).

  • list of (RoutingInstance object, RoutingPolicyType attribute)

    Created By: User (Reference to internal routing instance object automatically generated by system. Reference has property of sequence number which is order of in which routing policies are applied to given routing instance.)

    Operations Allowed: CRUD

    Description:

Referred by:

add_routing_instance(ref_obj, ref_data)

Add routing-instance to routing-policy.

Parameters:
  • ref_obj – RoutingInstance object
  • ref_data – RoutingPolicyType object
add_service_instance(ref_obj, ref_data)

Add service-instance to routing-policy.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – RoutingPolicyServiceInstanceType object
display_name

Get display-name for routing-policy.

Returns:xsd:string object
dump()

Display routing-policy object in compact form.

get_fq_name()

Return FQN of routing-policy in list form.

get_fq_name_str()

Return FQN of routing-policy as colon delimited string.

get_parent_fq_name()

Return FQN of routing-policy’s parent in list form.

get_parent_fq_name_str()

Return FQN of routing-policy’s parent as colon delimted string.

get_routing_instance_refs()

Return routing-instance list for routing-policy.

Returns:list of tuple <RoutingInstance, RoutingPolicyType>
get_service_instance_refs()

Return service-instance list for routing-policy.

Returns:list of tuple <ServiceInstance, RoutingPolicyServiceInstanceType>
get_type()

Return object type (routing-policy).

id_perms

Get id-perms for routing-policy.

Returns:IdPermsType object
perms2

Get perms2 for routing-policy.

Returns:PermType2 object
routing_policy_entries

Get routing-policy-entries for routing-policy.

Returns:PolicyStatementType object
set_routing_instance(ref_obj, ref_data)

Set routing-instance for routing-policy.

Parameters:
  • ref_obj – RoutingInstance object
  • ref_data – RoutingPolicyType object
set_routing_instance_list(ref_obj_list, ref_data_list)

Set routing-instance list for routing-policy.

Parameters:
  • ref_obj_list – list of RoutingInstance object
  • ref_data_list – list of RoutingPolicyType object
set_service_instance(ref_obj, ref_data)

Set service-instance for routing-policy.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – RoutingPolicyServiceInstanceType object
set_service_instance_list(ref_obj_list, ref_data_list)

Set service-instance list for routing-policy.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of RoutingPolicyServiceInstanceType object
class vnc_cfg_api_server.gen.resource_common.SecurityGroup(name=None, parent_obj=None, security_group_id=None, configured_security_group_id=None, security_group_entries=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents security-group configuration representation.

Child of:
Project object OR
Properties:
  • security_group_id

    Type: string

    Created By: System

    Operations Allowed: CR

    Description:

    Unique 32 bit ID automatically assigned to this security group [8M+1, 32G].

  • configured_security_group_id

    Type: int

    Created By: User (optional)

    Operations Allowed: CRUDUNIQUE 32 BIT USER DEFINED ID ASSIGNED TO THIS SECURITY GROUP [1, 8M].

    Description:

  • security_group_entries

    Type: PolicyEntriesType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Security group rule entries.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of AccessControlList objects

    Created By: System

    Operations Allowed: CRUD

    Description:

    port access control list is automatcally derived from all the security groups attached to port.

References to:

Referred by:
configured_security_group_id

Get configured-security-group-id for security-group.

Returns:xsd:integer object
display_name

Get display-name for security-group.

Returns:xsd:string object
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_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_type()

Return object type (security-group).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this security-group

id_perms

Get id-perms for security-group.

Returns:IdPermsType object
perms2

Get perms2 for security-group.

Returns:PermType2 object
security_group_entries

Get security-group-entries for security-group.

Returns:PolicyEntriesType object
security_group_id

Get security-group-id for security-group.

Returns:xsd:string object
class vnc_cfg_api_server.gen.resource_common.ServiceAppliance(name=None, parent_obj=None, service_appliance_user_credentials=None, service_appliance_ip_address=None, service_appliance_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents service-appliance configuration representation.

Child of:
ServiceApplianceSet object OR
Properties:
  • service_appliance_user_credentials

    Type: UserCredentials

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Authentication credentials for driver to access service appliance.

  • service_appliance_ip_address

    Type: string, one-of xsd:string

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Manegment Ip address of the service-appliance.

  • service_appliance_properties

    Type: KeyValuePairs

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    List of Key:Value pairs used by the provider driver of this service appliance.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (PhysicalInterface object, ServiceApplianceInterfaceType attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to physical interface that can be used as (service interface type)left, right, manegement

    OR other.

Referred by:

add_physical_interface(ref_obj, ref_data)

Add physical-interface to service-appliance.

Parameters:
  • ref_obj – PhysicalInterface object
  • ref_data – ServiceApplianceInterfaceType object
display_name

Get display-name for service-appliance.

Returns:xsd:string object
dump()

Display service-appliance object in compact form.

get_fq_name()

Return FQN of service-appliance in list form.

get_fq_name_str()

Return FQN of service-appliance as colon delimited string.

get_parent_fq_name()

Return FQN of service-appliance’s parent in list form.

get_parent_fq_name_str()

Return FQN of service-appliance’s parent as colon delimted string.

get_physical_interface_refs()

Return physical-interface list for service-appliance.

Returns:list of tuple <PhysicalInterface, ServiceApplianceInterfaceType>
get_type()

Return object type (service-appliance).

id_perms

Get id-perms for service-appliance.

Returns:IdPermsType object
perms2

Get perms2 for service-appliance.

Returns:PermType2 object
service_appliance_ip_address

Get service-appliance-ip-address for service-appliance.

Returns:IpAddressType object
service_appliance_properties

Get service-appliance-properties for service-appliance.

Returns:KeyValuePairs object
service_appliance_user_credentials

Get service-appliance-user-credentials for service-appliance.

Returns:UserCredentials object
set_physical_interface(ref_obj, ref_data)

Set physical-interface for service-appliance.

Parameters:
  • ref_obj – PhysicalInterface object
  • ref_data – ServiceApplianceInterfaceType object
set_physical_interface_list(ref_obj_list, ref_data_list)

Set physical-interface list for service-appliance.

Parameters:
  • ref_obj_list – list of PhysicalInterface object
  • ref_data_list – list of ServiceApplianceInterfaceType object
class vnc_cfg_api_server.gen.resource_common.ServiceApplianceSet(name=None, parent_obj=None, service_appliance_set_properties=None, service_appliance_driver=None, service_appliance_ha_mode=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents service-appliance-set configuration representation.

Child of:
GlobalSystemConfig object OR
Properties:
  • service_appliance_set_properties

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    List of Key:Value pairs that are used by the provider driver and opaque to system.

  • service_appliance_driver

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Name of the provider driver for this service appliance set.

  • service_appliance_ha_mode

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    High availability mode for the service appliance set, active-active or active-backup.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:
  • list of ServiceAppliance objects

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Service appliance is a member in service appliance set (e.g. Loadbalancer, Firewall provider).By

    default system will create “ha-proxy” based service appliance.

References to:

Referred by:
display_name

Get display-name for service-appliance-set.

Returns:xsd:string object
dump()

Display service-appliance-set object in compact form.

get_fq_name()

Return FQN of service-appliance-set in list form.

get_fq_name_str()

Return FQN of service-appliance-set as colon delimited string.

get_loadbalancer_pool_back_refs()

Return list of all loadbalancer-pools using this service-appliance-set

get_parent_fq_name()

Return FQN of service-appliance-set’s parent in list form.

get_parent_fq_name_str()

Return FQN of service-appliance-set’s parent as colon delimted string.

get_service_template_back_refs()

Return list of all service-templates using this service-appliance-set

get_type()

Return object type (service-appliance-set).

id_perms

Get id-perms for service-appliance-set.

Returns:IdPermsType object
perms2

Get perms2 for service-appliance-set.

Returns:PermType2 object
service_appliance_driver

Get service-appliance-driver for service-appliance-set.

Returns:xsd:string object
service_appliance_ha_mode

Get service-appliance-ha-mode for service-appliance-set.

Returns:xsd:string object
service_appliance_set_properties

Get service-appliance-set-properties for service-appliance-set.

Returns:KeyValuePairs object
class vnc_cfg_api_server.gen.resource_common.ServiceHealthCheck(name=None, parent_obj=None, service_health_check_properties=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents service-health-check configuration representation.

Child of:
Project object OR
Properties:
  • service_health_check_properties

    Type: ServiceHealthCheckType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Service health check has following fields.

  • id_perms

    Type: IdPermsType

    Created By: System

    Operations Allowed: R

    Description:

    System maintained identity, time and permissions data.

  • perms2

    Type: PermType2

    Created By: System

    Operations Allowed: R

    Description:

    Permissions data for role based access.

  • display_name

    Type: string

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Display name user configured string(name) that can be updated any time. Used as openstack name.

Children:

References to:
  • list of (ServiceInstance object, ServiceInterfaceTag attribute)

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Reference to service instance using this service health check.

Referred by:
add_service_instance(ref_obj, ref_data)

Add service-instance to service-health-check.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
display_name

Get display-name for service-health-check.

Returns:xsd:string object
dump()

Display service-health-check object in compact form.

get_fq_name()

Return FQN of service-health-check in list form.

get_fq_name_str()

Return FQN of service-health-check as colon delimited string.

get_parent_fq_name()

Return FQN of service-health-check’s parent in list form.

get_parent_fq_name_str()

Return FQN of service-health-check’s parent as colon delimted string.

get_service_instance_refs()

Return service-instance list for service-health-check.

Returns:list of tuple <ServiceInstance, ServiceInterfaceTag>
get_type()

Return object type (service-health-check).

get_virtual_machine_interface_back_refs()

Return list of all virtual-machine-interfaces using this service-health-check

id_perms

Get id-perms for service-health-check.

Returns:IdPermsType object
perms2

Get perms2 for service-health-check.

Returns:PermType2 object
service_health_check_properties

Get service-health-check-properties for service-health-check.

Returns:ServiceHealthCheckType object
set_service_instance(ref_obj, ref_data)

Set service-instance for service-health-check.

Parameters:
  • ref_obj – ServiceInstance object
  • ref_data – ServiceInterfaceTag object
set_service_instance_list(ref_obj_list, ref_data_list)

Set service-instance list for service-health-check.

Parameters:
  • ref_obj_list – list of ServiceInstance object
  • ref_data_list – list of ServiceInterfaceTag object
class vnc_cfg_api_server.gen.resource_common.ServiceInstance(name=None, parent_obj=None, service_instance_properties=None, service_instance_bindings=None, id_perms=None, perms2=None, display_name=None, *args, **kwargs)

Bases: object

Represents service-instance configuration representation.

Child of:
Project object OR
Properties:
  • service_instance_properties

    Type: ServiceInstanceType

    Created By: User (required)

    Operations Allowed: CRUD

    Description:

    Service instance configuration parameters.

  • service_instance_bindings

    Type: KeyValuePairs

    Created By: User (optional)

    Operations Allowed: CRUD

    Description:

    Opaque key value pair for generating config for the service instance.

  • id_perms

    Type: