Bases: object
This class provides type specific methods to create, read, update, delete and list objects from the server
Create new access-control-list.
Parameters: | obj – AccessControlList object |
---|
Delete access-control-list from the system.
Parameters: |
|
---|
Return access-control-list information.
Parameters: |
|
---|---|
Returns: | AccessControlList object |
Update access-control-list.
Parameters: | obj – AccessControlList object |
---|
List all access-control-lists.
Parameters: |
|
---|---|
Returns: | list of AccessControlList objects |
Delete alarm from the system.
Parameters: |
|
---|
Return alarm information.
Parameters: |
|
---|---|
Returns: | Alarm object |
List all alarms.
Parameters: |
|
---|---|
Returns: | list of Alarm objects |
Delete alias-ip from the system.
Parameters: |
|
---|
Create new alias-ip-pool.
Parameters: | obj – AliasIpPool object |
---|
Delete alias-ip-pool from the system.
Parameters: |
|
---|
Return alias-ip-pool information.
Parameters: |
|
---|---|
Returns: | AliasIpPool object |
Update alias-ip-pool.
Parameters: | obj – AliasIpPool object |
---|
List all alias-ip-pools.
Parameters: |
|
---|---|
Returns: | list of AliasIpPool objects |
Return alias-ip information.
Parameters: |
|
---|---|
Returns: | AliasIp object |
List all alias-ips.
Parameters: |
|
---|---|
Returns: | list of AliasIp objects |
Create new analytics-node.
Parameters: | obj – AnalyticsNode object |
---|
Delete analytics-node from the system.
Parameters: |
|
---|
Return analytics-node information.
Parameters: |
|
---|---|
Returns: | AnalyticsNode object |
Update analytics-node.
Parameters: | obj – AnalyticsNode object |
---|
List all analytics-nodes.
Parameters: |
|
---|---|
Returns: | list of AnalyticsNode objects |
Create new api-access-list.
Parameters: | obj – ApiAccessList object |
---|
Delete api-access-list from the system.
Parameters: |
|
---|
Return api-access-list information.
Parameters: |
|
---|---|
Returns: | ApiAccessList object |
Update api-access-list.
Parameters: | obj – ApiAccessList object |
---|
List all api-access-lists.
Parameters: |
|
---|---|
Returns: | list of ApiAccessList objects |
Create new bgp-as-a-service.
Parameters: | obj – BgpAsAService object |
---|
Delete bgp-as-a-service from the system.
Parameters: |
|
---|
Return bgp-as-a-service information.
Parameters: |
|
---|---|
Returns: | BgpAsAService object |
Update bgp-as-a-service.
Parameters: | obj – BgpAsAService object |
---|
List all bgp-as-a-services.
Parameters: |
|
---|---|
Returns: | list of BgpAsAService objects |
Delete bgp-router from the system.
Parameters: |
|
---|
Return bgp-router information.
Parameters: |
|
---|---|
Returns: | BgpRouter object |
List all bgp-routers.
Parameters: |
|
---|---|
Returns: | list of BgpRouter objects |
Create new config-node.
Parameters: | obj – ConfigNode object |
---|
Delete config-node from the system.
Parameters: |
|
---|
Return config-node information.
Parameters: |
|
---|---|
Returns: | ConfigNode object |
Update config-node.
Parameters: | obj – ConfigNode object |
---|
List all config-nodes.
Parameters: |
|
---|---|
Returns: | list of ConfigNode objects |
Create new config-root.
Parameters: | obj – ConfigRoot object |
---|
Delete config-root from the system.
Parameters: |
|
---|
Return config-root information.
Parameters: |
|
---|---|
Returns: | ConfigRoot object |
Update config-root.
Parameters: | obj – ConfigRoot object |
---|
List all config-roots.
Create new customer-attachment.
Parameters: | obj – CustomerAttachment object |
---|
Delete customer-attachment from the system.
Parameters: |
|
---|
Return customer-attachment information.
Parameters: |
|
---|---|
Returns: | CustomerAttachment object |
Update customer-attachment.
Parameters: | obj – CustomerAttachment object |
---|
List all customer-attachments.
Create new database-node.
Parameters: | obj – DatabaseNode object |
---|
Delete database-node from the system.
Parameters: |
|
---|
Return database-node information.
Parameters: |
|
---|---|
Returns: | DatabaseNode object |
Update database-node.
Parameters: | obj – DatabaseNode object |
---|
List all database-nodes.
Parameters: |
|
---|---|
Returns: | list of DatabaseNode objects |
Create new discovery-service-assignment.
Parameters: | obj – DiscoveryServiceAssignment object |
---|
Delete discovery-service-assignment from the system.
Parameters: |
|
---|
Return discovery-service-assignment information.
Parameters: |
|
---|---|
Returns: | DiscoveryServiceAssignment object |
Update discovery-service-assignment.
Parameters: | obj – DiscoveryServiceAssignment object |
---|
List all discovery-service-assignments.
Delete domain from the system.
Parameters: |
|
---|
Return domain information.
Parameters: |
|
---|---|
Returns: | Domain object |
List all domains.
Parameters: |
|
---|---|
Returns: | list of Domain objects |
Delete dsa-rule from the system.
Parameters: |
|
---|
Return dsa-rule information.
Parameters: |
|
---|---|
Returns: | DsaRule object |
List all dsa-rules.
Parameters: |
|
---|---|
Returns: | list of DsaRule objects |
Create new floating-ip.
Parameters: | obj – FloatingIp object |
---|
Delete floating-ip from the system.
Parameters: |
|
---|
Create new floating-ip-pool.
Parameters: | obj – FloatingIpPool object |
---|
Delete floating-ip-pool from the system.
Parameters: |
|
---|
Return floating-ip-pool information.
Parameters: |
|
---|---|
Returns: | FloatingIpPool object |
Update floating-ip-pool.
Parameters: | obj – FloatingIpPool object |
---|
List all floating-ip-pools.
Parameters: |
|
---|---|
Returns: | list of FloatingIpPool objects |
Return floating-ip information.
Parameters: |
|
---|---|
Returns: | FloatingIp object |
Update floating-ip.
Parameters: | obj – FloatingIp object |
---|
List all floating-ips.
Parameters: |
|
---|---|
Returns: | list of FloatingIp objects |
Create new forwarding-class.
Parameters: | obj – ForwardingClass object |
---|
Delete forwarding-class from the system.
Parameters: |
|
---|
Return forwarding-class information.
Parameters: |
|
---|---|
Returns: | ForwardingClass object |
Update forwarding-class.
Parameters: | obj – ForwardingClass object |
---|
List all forwarding-classs.
Parameters: |
|
---|---|
Returns: | list of ForwardingClass objects |
Return UUID of default access-control-list.
Return UUID of default alarm.
Return UUID of default alias-ip.
Return UUID of default alias-ip-pool.
Return UUID of default analytics-node.
Return UUID of default api-access-list.
Return UUID of default bgp-as-a-service.
Return UUID of default bgp-router.
Return UUID of default config-node.
Return UUID of default config-root.
Return UUID of default customer-attachment.
Return UUID of default database-node.
Return UUID of default discovery-service-assignment.
Return UUID of default domain.
Return UUID of default dsa-rule.
Return UUID of default floating-ip.
Return UUID of default floating-ip-pool.
Return UUID of default forwarding-class.
Return UUID of default global-qos-config.
Return UUID of default global-system-config.
Return UUID of default global-vrouter-config.
Return UUID of default instance-ip.
Return UUID of default interface-route-table.
Return UUID of default loadbalancer-healthmonitor.
Return UUID of default loadbalancer.
Return UUID of default loadbalancer-listener.
Return UUID of default loadbalancer-member.
Return UUID of default loadbalancer-pool.
Return UUID of default logical-interface.
Return UUID of default logical-router.
Return UUID of default namespace.
Return UUID of default network-ipam.
Return UUID of default network-policy.
Return UUID of default physical-interface.
Return UUID of default physical-router.
Return UUID of default port-tuple.
Return UUID of default project.
Return UUID of default provider-attachment.
Return UUID of default qos-config.
Return UUID of default qos-queue.
Return UUID of default route-aggregate.
Return UUID of default route-table.
Return UUID of default route-target.
Return UUID of default routing-instance.
Return UUID of default routing-policy.
Return UUID of default security-group.
Return UUID of default service-appliance.
Return UUID of default service-appliance-set.
Return UUID of default service-health-check.
Return UUID of default service-instance.
Return UUID of default service-template.
Return UUID of default subnet.
Return UUID of default virtual-DNS.
Return UUID of default virtual-DNS-record.
Return UUID of default virtual-ip.
Return UUID of default virtual-machine.
Return UUID of default virtual-machine-interface.
Return UUID of default virtual-network.
Return UUID of default virtual-router.
Create new global-qos-config.
Parameters: | obj – GlobalQosConfig object |
---|
Delete global-qos-config from the system.
Parameters: |
|
---|
Return global-qos-config information.
Parameters: |
|
---|---|
Returns: | GlobalQosConfig object |
Update global-qos-config.
Parameters: | obj – GlobalQosConfig object |
---|
List all global-qos-configs.
Parameters: |
|
---|---|
Returns: | list of GlobalQosConfig objects |
Create new global-system-config.
Parameters: | obj – GlobalSystemConfig object |
---|
Delete global-system-config from the system.
Parameters: |
|
---|
Return global-system-config information.
Parameters: |
|
---|---|
Returns: | GlobalSystemConfig object |
Update global-system-config.
Parameters: | obj – GlobalSystemConfig object |
---|
List all global-system-configs.
Parameters: |
|
---|---|
Returns: | list of GlobalSystemConfig objects |
Create new global-vrouter-config.
Parameters: | obj – GlobalVrouterConfig object |
---|
Delete global-vrouter-config from the system.
Parameters: |
|
---|
Return global-vrouter-config information.
Parameters: |
|
---|---|
Returns: | GlobalVrouterConfig object |
Update global-vrouter-config.
Parameters: | obj – GlobalVrouterConfig object |
---|
List all global-vrouter-configs.
Parameters: |
|
---|---|
Returns: | list of GlobalVrouterConfig objects |
Create new instance-ip.
Parameters: | obj – InstanceIp object |
---|
Delete instance-ip from the system.
Parameters: |
|
---|
Return instance-ip information.
Parameters: |
|
---|---|
Returns: | InstanceIp object |
Update instance-ip.
Parameters: | obj – InstanceIp object |
---|
List all instance-ips.
Create new interface-route-table.
Parameters: | obj – InterfaceRouteTable object |
---|
Delete interface-route-table from the system.
Parameters: |
|
---|
Return interface-route-table information.
Parameters: |
|
---|---|
Returns: | InterfaceRouteTable object |
Update interface-route-table.
Parameters: | obj – InterfaceRouteTable object |
---|
List all interface-route-tables.
Parameters: |
|
---|---|
Returns: | list of InterfaceRouteTable objects |
Create new loadbalancer.
Parameters: | obj – Loadbalancer object |
---|
Delete loadbalancer from the system.
Parameters: |
|
---|
Create new loadbalancer-healthmonitor.
Parameters: | obj – LoadbalancerHealthmonitor object |
---|
Delete loadbalancer-healthmonitor from the system.
Parameters: |
|
---|
Return loadbalancer-healthmonitor information.
Parameters: |
|
---|---|
Returns: | LoadbalancerHealthmonitor object |
Update loadbalancer-healthmonitor.
Parameters: | obj – LoadbalancerHealthmonitor object |
---|
List all loadbalancer-healthmonitors.
Parameters: |
|
---|---|
Returns: | list of LoadbalancerHealthmonitor objects |
Create new loadbalancer-listener.
Parameters: | obj – LoadbalancerListener object |
---|
Delete loadbalancer-listener from the system.
Parameters: |
|
---|
Return loadbalancer-listener information.
Parameters: |
|
---|---|
Returns: | LoadbalancerListener object |
Update loadbalancer-listener.
Parameters: | obj – LoadbalancerListener object |
---|
List all loadbalancer-listeners.
Parameters: |
|
---|---|
Returns: | list of LoadbalancerListener objects |
Create new loadbalancer-member.
Parameters: | obj – LoadbalancerMember object |
---|
Delete loadbalancer-member from the system.
Parameters: |
|
---|
Return loadbalancer-member information.
Parameters: |
|
---|---|
Returns: | LoadbalancerMember object |
Update loadbalancer-member.
Parameters: | obj – LoadbalancerMember object |
---|
List all loadbalancer-members.
Parameters: |
|
---|---|
Returns: | list of LoadbalancerMember objects |
Create new loadbalancer-pool.
Parameters: | obj – LoadbalancerPool object |
---|
Delete loadbalancer-pool from the system.
Parameters: |
|
---|
Return loadbalancer-pool information.
Parameters: |
|
---|---|
Returns: | LoadbalancerPool object |
Update loadbalancer-pool.
Parameters: | obj – LoadbalancerPool object |
---|
List all loadbalancer-pools.
Parameters: |
|
---|---|
Returns: | list of LoadbalancerPool objects |
Return loadbalancer information.
Parameters: |
|
---|---|
Returns: | Loadbalancer object |
Update loadbalancer.
Parameters: | obj – Loadbalancer object |
---|
List all loadbalancers.
Parameters: |
|
---|---|
Returns: | list of Loadbalancer objects |
Create new logical-interface.
Parameters: | obj – LogicalInterface object |
---|
Delete logical-interface from the system.
Parameters: |
|
---|
Return logical-interface information.
Parameters: |
|
---|---|
Returns: | LogicalInterface object |
Update logical-interface.
Parameters: | obj – LogicalInterface object |
---|
List all logical-interfaces.
Parameters: |
|
---|---|
Returns: | list of LogicalInterface objects |
Create new logical-router.
Parameters: | obj – LogicalRouter object |
---|
Delete logical-router from the system.
Parameters: |
|
---|
Return logical-router information.
Parameters: |
|
---|---|
Returns: | LogicalRouter object |
Update logical-router.
Parameters: | obj – LogicalRouter object |
---|
List all logical-routers.
Parameters: |
|
---|---|
Returns: | list of LogicalRouter objects |
Delete namespace from the system.
Parameters: |
|
---|
Return namespace information.
Parameters: |
|
---|---|
Returns: | Namespace object |
List all namespaces.
Parameters: |
|
---|---|
Returns: | list of Namespace objects |
Create new network-ipam.
Parameters: | obj – NetworkIpam object |
---|
Delete network-ipam from the system.
Parameters: |
|
---|
Return network-ipam information.
Parameters: |
|
---|---|
Returns: | NetworkIpam object |
Update network-ipam.
Parameters: | obj – NetworkIpam object |
---|
List all network-ipams.
Parameters: |
|
---|---|
Returns: | list of NetworkIpam objects |
Create new network-policy.
Parameters: | obj – NetworkPolicy object |
---|
Delete network-policy from the system.
Parameters: |
|
---|
Return network-policy information.
Parameters: |
|
---|---|
Returns: | NetworkPolicy object |
Update network-policy.
Parameters: | obj – NetworkPolicy object |
---|
List all network-policys.
Parameters: |
|
---|---|
Returns: | list of NetworkPolicy objects |
Create new physical-interface.
Parameters: | obj – PhysicalInterface object |
---|
Delete physical-interface from the system.
Parameters: |
|
---|
Return physical-interface information.
Parameters: |
|
---|---|
Returns: | PhysicalInterface object |
Update physical-interface.
Parameters: | obj – PhysicalInterface object |
---|
List all physical-interfaces.
Parameters: |
|
---|---|
Returns: | list of PhysicalInterface objects |
Create new physical-router.
Parameters: | obj – PhysicalRouter object |
---|
Delete physical-router from the system.
Parameters: |
|
---|
Return physical-router information.
Parameters: |
|
---|---|
Returns: | PhysicalRouter object |
Update physical-router.
Parameters: | obj – PhysicalRouter object |
---|
List all physical-routers.
Parameters: |
|
---|---|
Returns: | list of PhysicalRouter objects |
Delete port-tuple from the system.
Parameters: |
|
---|
Return port-tuple information.
Parameters: |
|
---|---|
Returns: | PortTuple object |
List all port-tuples.
Parameters: |
|
---|---|
Returns: | list of PortTuple objects |
Delete project from the system.
Parameters: |
|
---|
Return project information.
Parameters: |
|
---|---|
Returns: | Project object |
List all projects.
Parameters: |
|
---|---|
Returns: | list of Project objects |
Create new provider-attachment.
Parameters: | obj – ProviderAttachment object |
---|
Delete provider-attachment from the system.
Parameters: |
|
---|
Return provider-attachment information.
Parameters: |
|
---|---|
Returns: | ProviderAttachment object |
Update provider-attachment.
Parameters: | obj – ProviderAttachment object |
---|
List all provider-attachments.
Delete qos-config from the system.
Parameters: |
|
---|
Return qos-config information.
Parameters: |
|
---|---|
Returns: | QosConfig object |
List all qos-configs.
Parameters: |
|
---|---|
Returns: | list of QosConfig objects |
Delete qos-queue from the system.
Parameters: |
|
---|
Return qos-queue information.
Parameters: |
|
---|---|
Returns: | QosQueue object |
List all qos-queues.
Parameters: |
|
---|---|
Returns: | list of QosQueue objects |
Create new route-aggregate.
Parameters: | obj – RouteAggregate object |
---|
Delete route-aggregate from the system.
Parameters: |
|
---|
Return route-aggregate information.
Parameters: |
|
---|---|
Returns: | RouteAggregate object |
Update route-aggregate.
Parameters: | obj – RouteAggregate object |
---|
List all route-aggregates.
Parameters: |
|
---|---|
Returns: | list of RouteAggregate objects |
Create new route-table.
Parameters: | obj – RouteTable object |
---|
Delete route-table from the system.
Parameters: |
|
---|
Return route-table information.
Parameters: |
|
---|---|
Returns: | RouteTable object |
Update route-table.
Parameters: | obj – RouteTable object |
---|
List all route-tables.
Parameters: |
|
---|---|
Returns: | list of RouteTable objects |
Create new route-target.
Parameters: | obj – RouteTarget object |
---|
Delete route-target from the system.
Parameters: |
|
---|
Return route-target information.
Parameters: |
|
---|---|
Returns: | RouteTarget object |
Update route-target.
Parameters: | obj – RouteTarget object |
---|
List all route-targets.
Create new routing-instance.
Parameters: | obj – RoutingInstance object |
---|
Delete routing-instance from the system.
Parameters: |
|
---|
Return routing-instance information.
Parameters: |
|
---|---|
Returns: | RoutingInstance object |
Update routing-instance.
Parameters: | obj – RoutingInstance object |
---|
List all routing-instances.
Parameters: |
|
---|---|
Returns: | list of RoutingInstance objects |
Create new routing-policy.
Parameters: | obj – RoutingPolicy object |
---|
Delete routing-policy from the system.
Parameters: |
|
---|
Return routing-policy information.
Parameters: |
|
---|---|
Returns: | RoutingPolicy object |
Update routing-policy.
Parameters: | obj – RoutingPolicy object |
---|
List all routing-policys.
Parameters: |
|
---|---|
Returns: | list of RoutingPolicy objects |
Create new security-group.
Parameters: | obj – SecurityGroup object |
---|
Delete security-group from the system.
Parameters: |
|
---|
Return security-group information.
Parameters: |
|
---|---|
Returns: | SecurityGroup object |
Update security-group.
Parameters: | obj – SecurityGroup object |
---|
List all security-groups.
Parameters: |
|
---|---|
Returns: | list of SecurityGroup objects |
Create new service-appliance.
Parameters: | obj – ServiceAppliance object |
---|
Delete service-appliance from the system.
Parameters: |
|
---|
Return service-appliance information.
Parameters: |
|
---|---|
Returns: | ServiceAppliance object |
Create new service-appliance-set.
Parameters: | obj – ServiceApplianceSet object |
---|
Delete service-appliance-set from the system.
Parameters: |
|
---|
Return service-appliance-set information.
Parameters: |
|
---|---|
Returns: | ServiceApplianceSet object |
Update service-appliance-set.
Parameters: | obj – ServiceApplianceSet object |
---|
List all service-appliance-sets.
Parameters: |
|
---|---|
Returns: | list of ServiceApplianceSet objects |
Update service-appliance.
Parameters: | obj – ServiceAppliance object |
---|
List all service-appliances.
Parameters: |
|
---|---|
Returns: | list of ServiceAppliance objects |
Create new service-health-check.
Parameters: | obj – ServiceHealthCheck object |
---|
Delete service-health-check from the system.
Parameters: |
|
---|
Return service-health-check information.
Parameters: |
|
---|---|
Returns: | ServiceHealthCheck object |
Update service-health-check.
Parameters: | obj – ServiceHealthCheck object |
---|
List all service-health-checks.
Parameters: |
|
---|---|
Returns: | list of ServiceHealthCheck objects |
Create new service-instance.
Parameters: | obj – ServiceInstance object |
---|
Delete service-instance from the system.
Parameters: |
|
---|
Return service-instance information.
Parameters: |
|
---|---|
Returns: | ServiceInstance object |
Update service-instance.
Parameters: | obj – ServiceInstance object |
---|
List all service-instances.
Parameters: |
|
---|---|
Returns: | list of ServiceInstance objects |
Create new service-template.
Parameters: | obj – ServiceTemplate object |
---|
Delete service-template from the system.
Parameters: |
|
---|
Return service-template information.
Parameters: |
|
---|---|
Returns: | ServiceTemplate object |
Update service-template.
Parameters: | obj – ServiceTemplate object |
---|
List all service-templates.
Parameters: |
|
---|---|
Returns: | list of ServiceTemplate objects |
Delete subnet from the system.
Parameters: |
|
---|
Return subnet information.
Parameters: |
|
---|---|
Returns: | Subnet object |
List all subnets.
Create new virtual-DNS.
Parameters: | obj – VirtualDns object |
---|
Delete virtual-DNS from the system.
Parameters: |
|
---|
Return virtual-DNS information.
Parameters: |
|
---|---|
Returns: | VirtualDns object |
Create new virtual-DNS-record.
Parameters: | obj – VirtualDnsRecord object |
---|
Delete virtual-DNS-record from the system.
Parameters: |
|
---|
Return virtual-DNS-record information.
Parameters: |
|
---|---|
Returns: | VirtualDnsRecord object |
Update virtual-DNS-record.
Parameters: | obj – VirtualDnsRecord object |
---|
List all virtual-DNS-records.
Parameters: |
|
---|---|
Returns: | list of VirtualDnsRecord objects |
Update virtual-DNS.
Parameters: | obj – VirtualDns object |
---|
List all virtual-DNSs.
Parameters: |
|
---|---|
Returns: | list of VirtualDns objects |
Delete virtual-ip from the system.
Parameters: |
|
---|
Return virtual-ip information.
Parameters: |
|
---|---|
Returns: | VirtualIp object |
List all virtual-ips.
Parameters: |
|
---|---|
Returns: | list of VirtualIp objects |
Create new virtual-machine.
Parameters: | obj – VirtualMachine object |
---|
Delete virtual-machine from the system.
Parameters: |
|
---|
Create new virtual-machine-interface.
Parameters: | obj – VirtualMachineInterface object |
---|
Delete virtual-machine-interface from the system.
Parameters: |
|
---|
Return virtual-machine-interface information.
Parameters: |
|
---|---|
Returns: | VirtualMachineInterface object |
Update virtual-machine-interface.
Parameters: | obj – VirtualMachineInterface object |
---|
List all virtual-machine-interfaces.
Parameters: |
|
---|---|
Returns: | list of VirtualMachineInterface objects |
Return virtual-machine information.
Parameters: |
|
---|---|
Returns: | VirtualMachine object |
Update virtual-machine.
Parameters: | obj – VirtualMachine object |
---|
List all virtual-machines.
Create new virtual-network.
Parameters: | obj – VirtualNetwork object |
---|
Delete virtual-network from the system.
Parameters: |
|
---|
Return virtual-network information.
Parameters: |
|
---|---|
Returns: | VirtualNetwork object |
Update virtual-network.
Parameters: | obj – VirtualNetwork object |
---|
List all virtual-networks.
Parameters: |
|
---|---|
Returns: | list of VirtualNetwork objects |
Create new virtual-router.
Parameters: | obj – VirtualRouter object |
---|
Delete virtual-router from the system.
Parameters: |
|
---|
Return virtual-router information.
Parameters: |
|
---|---|
Returns: | VirtualRouter object |
Update virtual-router.
Parameters: | obj – VirtualRouter object |
---|
List all virtual-routers.
Parameters: |
|
---|---|
Returns: | list of VirtualRouter objects |
This module defines the classes for every configuration element managed by the system
Bases: object
Represents access-control-list configuration representation.
Type: AclEntriesType
Created By: System
Operations Allowed: CRUD
Description:
Automatically generated by system based on security groups or network policies.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get access-control-list-entries for access-control-list.
Returns: | AclEntriesType object |
---|
Get display-name for access-control-list.
Returns: | xsd:string object |
---|
Display access-control-list object in compact form.
Return FQN of access-control-list in list form.
Return FQN of access-control-list as colon delimited string.
Return FQN of access-control-list’s parent in list form.
Return FQN of access-control-list’s parent as colon delimted string.
Return object type (access-control-list).
Get id-perms for access-control-list.
Returns: | IdPermsType object |
---|
Get perms2 for access-control-list.
Returns: | PermType2 object |
---|
Bases: object
Represents alarm configuration representation.
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>
Type: int, one-of [u‘0’, u‘7’]
Created By: User (required)
Operations Allowed: CRUD
Description:
Severity level for the alarm.
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}, ...]}]}
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get alarm-rules for alarm.
Returns: | AlarmOrList object |
---|
Get alarm-severity for alarm.
Returns: | AlarmSeverity object |
---|
Get display-name for alarm.
Returns: | xsd:string object |
---|
Display alarm object in compact form.
Return FQN of alarm in list form.
Return FQN of alarm as colon delimited string.
Return FQN of alarm’s parent in list form.
Return FQN of alarm’s parent as colon delimted string.
Return object type (alarm).
Get id-perms for alarm.
Returns: | IdPermsType object |
---|
Get perms2 for alarm.
Returns: | PermType2 object |
---|
Get uve-keys for alarm.
Returns: | xsd:string object |
---|
Bases: object
Represents alias-ip configuration representation.
Type: string, one-of []
Created By: User (required)
Operations Allowed: CR
Description:
Alias ip address.
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
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to project from which this alias ip was allocated.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to virtual machine interface to which this alias ip is attached.
Referred by:
Add project to alias-ip.
Parameters: | ref_obj – Project object |
---|
Add virtual-machine-interface to alias-ip.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Get alias-ip-address for alias-ip.
Returns: | IpAddressType object |
---|
Get alias-ip-address-family for alias-ip.
Returns: | IpAddressFamilyType object |
---|
Get display-name for alias-ip.
Returns: | xsd:string object |
---|
Display alias-ip object in compact form.
Return FQN of alias-ip in list form.
Return FQN of alias-ip as colon delimited string.
Return FQN of alias-ip’s parent in list form.
Return FQN of alias-ip’s parent as colon delimted string.
Return project list for alias-ip.
Returns: | list of <Project> |
---|
Return object type (alias-ip).
Return virtual-machine-interface list for alias-ip.
Returns: | list of <VirtualMachineInterface> |
---|
Get id-perms for alias-ip.
Returns: | IdPermsType object |
---|
Get perms2 for alias-ip.
Returns: | PermType2 object |
---|
Set project for alias-ip.
Parameters: | ref_obj – Project object |
---|
Set project list for alias-ip.
Parameters: | ref_obj_list – list of Project object |
---|
Set virtual-machine-interface for alias-ip.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for alias-ip.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Bases: object
Represents alias-ip-pool configuration representation.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
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:
Get display-name for alias-ip-pool.
Returns: | xsd:string object |
---|
Display alias-ip-pool object in compact form.
Return FQN of alias-ip-pool in list form.
Return FQN of alias-ip-pool as colon delimited string.
Return FQN of alias-ip-pool’s parent in list form.
Return FQN of alias-ip-pool’s parent as colon delimted string.
Return list of all projects using this alias-ip-pool
Return object type (alias-ip-pool).
Get id-perms for alias-ip-pool.
Returns: | IdPermsType object |
---|
Get perms2 for alias-ip-pool.
Returns: | PermType2 object |
---|
Bases: object
Represents analytics-node configuration representation.
Type: string, one-of []
Created By: User (admin-only)
Operations Allowed: CRUD
Description:
Ip address of the analytics node, set while provisioning.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get analytics-node-ip-address for analytics-node.
Returns: | IpAddressType object |
---|
Get display-name for analytics-node.
Returns: | xsd:string object |
---|
Display analytics-node object in compact form.
Return FQN of analytics-node in list form.
Return FQN of analytics-node as colon delimited string.
Return FQN of analytics-node’s parent in list form.
Return FQN of analytics-node’s parent as colon delimted string.
Return object type (analytics-node).
Get id-perms for analytics-node.
Returns: | IdPermsType object |
---|
Get perms2 for analytics-node.
Returns: | PermType2 object |
---|
Bases: object
Represents api-access-list configuration representation.
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).
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get api-access-list-entries for api-access-list.
Returns: | RbacRuleEntriesType object |
---|
Get display-name for api-access-list.
Returns: | xsd:string object |
---|
Display api-access-list object in compact form.
Return FQN of api-access-list in list form.
Return FQN of api-access-list as colon delimited string.
Return FQN of api-access-list’s parent in list form.
Return FQN of api-access-list’s parent as colon delimted string.
Return object type (api-access-list).
Get id-perms for api-access-list.
Returns: | IdPermsType object |
---|
Get perms2 for api-access-list.
Returns: | PermType2 object |
---|
Bases: object
Represents bgp-as-a-service configuration representation.
Type: int, one-of [u‘1’, u‘65534’]
Created By: User (required)
Operations Allowed: CRUD
Description:
16 bit BGP Autonomous System number for the cluster.
Type: string, one-of []
Created By: User (required)
Operations Allowed: CRUD
Description:
Ip address of the BGP peer.
Type: BgpSessionAttributes
Created By: User (required)
Operations Allowed: CRUD
Description:
BGP peering session attributes.
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.
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.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to VMI on which BGPaaS BGP peering will happen.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Referred by:
Add bgp-router to bgp-as-a-service.
Parameters: | ref_obj – BgpRouter object |
---|
Add virtual-machine-interface to bgp-as-a-service.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Get autonomous-system for bgp-as-a-service.
Returns: | AutonomousSystemType object |
---|
Get bgpaas-ip-address for bgp-as-a-service.
Returns: | IpAddressType object |
---|
Get bgpaas-ipv4-mapped-ipv6-nexthop for bgp-as-a-service.
Returns: | xsd:boolean object |
---|
Get bgpaas-session-attributes for bgp-as-a-service.
Returns: | BgpSessionAttributes object |
---|
Get bgpaas-suppress-route-advertisement for bgp-as-a-service.
Returns: | xsd:boolean object |
---|
Get display-name for bgp-as-a-service.
Returns: | xsd:string object |
---|
Display bgp-as-a-service object in compact form.
Return bgp-router list for bgp-as-a-service.
Returns: | list of <BgpRouter> |
---|
Return FQN of bgp-as-a-service in list form.
Return FQN of bgp-as-a-service as colon delimited string.
Return FQN of bgp-as-a-service’s parent in list form.
Return FQN of bgp-as-a-service’s parent as colon delimted string.
Return object type (bgp-as-a-service).
Return virtual-machine-interface list for bgp-as-a-service.
Returns: | list of <VirtualMachineInterface> |
---|
Get id-perms for bgp-as-a-service.
Returns: | IdPermsType object |
---|
Get perms2 for bgp-as-a-service.
Returns: | PermType2 object |
---|
Set bgp-router for bgp-as-a-service.
Parameters: | ref_obj – BgpRouter object |
---|
Set bgp-router list for bgp-as-a-service.
Parameters: | ref_obj_list – list of BgpRouter object |
---|
Set virtual-machine-interface for bgp-as-a-service.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for bgp-as-a-service.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Bases: object
Represents bgp-router configuration representation.
Type: BgpRouterParams
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Add bgp-router to bgp-router.
Parameters: |
|
---|
Get bgp-router-parameters for bgp-router.
Returns: | BgpRouterParams object |
---|
Get display-name for bgp-router.
Returns: | xsd:string object |
---|
Display bgp-router object in compact form.
Return list of all bgp-as-a-services using this bgp-router
Return list of all bgp-routers using this bgp-router
Return bgp-router list for bgp-router.
Returns: | list of tuple <BgpRouter, BgpPeeringAttributes> |
---|
Return FQN of bgp-router in list form.
Return FQN of bgp-router as colon delimited string.
Return list of all global-system-configs using this bgp-router
Return FQN of bgp-router’s parent in list form.
Return FQN of bgp-router’s parent as colon delimted string.
Return list of all physical-routers using this bgp-router
Return object type (bgp-router).
Get id-perms for bgp-router.
Returns: | IdPermsType object |
---|
Get perms2 for bgp-router.
Returns: | PermType2 object |
---|
Set bgp-router for bgp-router.
Parameters: |
|
---|
Set bgp-router list for bgp-router.
Parameters: |
|
---|
Bases: object
Represents config-node configuration representation.
Type: string, one-of []
Created By: User (admin-only)
Operations Allowed: CRUD
Description:
Ip address of the config node, set while provisioning.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get config-node-ip-address for config-node.
Returns: | IpAddressType object |
---|
Get display-name for config-node.
Returns: | xsd:string object |
---|
Display config-node object in compact form.
Return FQN of config-node in list form.
Return FQN of config-node as colon delimited string.
Return FQN of config-node’s parent in list form.
Return FQN of config-node’s parent as colon delimted string.
Return object type (config-node).
Get id-perms for config-node.
Returns: | IdPermsType object |
---|
Get perms2 for config-node.
Returns: | PermType2 object |
---|
Bases: object
Represents config-root configuration representation.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (required)
Operations Allowed: R
Description:
Global system config is object where all global system configuration is present.
Created By: System
Operations Allowed: CRUD
Description:
Domain is authentication namespace, a collection of projects.
References to:
Referred by:
Get display-name for config-root.
Returns: | xsd:string object |
---|
Display config-root object in compact form.
Return FQN of config-root in list form.
Return FQN of config-root as colon delimited string.
Return object type (config-root).
Get id-perms for config-root.
Returns: | IdPermsType object |
---|
Get perms2 for config-root.
Returns: | PermType2 object |
---|
Bases: object
Represents customer-attachment configuration representation.
Type: AttachmentAddressType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Not in Use.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Not in Use.
Referred by:
Add floating-ip to customer-attachment.
Parameters: | ref_obj – FloatingIp object |
---|
Add virtual-machine-interface to customer-attachment.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Get attachment-address for customer-attachment.
Returns: | AttachmentAddressType object |
---|
Get display-name for customer-attachment.
Returns: | xsd:string object |
---|
Display customer-attachment object in compact form.
Return floating-ip list for customer-attachment.
Returns: | list of <FloatingIp> |
---|
Return FQN of customer-attachment in list form.
Return FQN of customer-attachment as colon delimited string.
Return object type (customer-attachment).
Return virtual-machine-interface list for customer-attachment.
Returns: | list of <VirtualMachineInterface> |
---|
Get id-perms for customer-attachment.
Returns: | IdPermsType object |
---|
Get perms2 for customer-attachment.
Returns: | PermType2 object |
---|
Set floating-ip for customer-attachment.
Parameters: | ref_obj – FloatingIp object |
---|
Set floating-ip list for customer-attachment.
Parameters: | ref_obj_list – list of FloatingIp object |
---|
Set virtual-machine-interface for customer-attachment.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for customer-attachment.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Bases: object
Represents database-node configuration representation.
Type: string, one-of []
Created By: User (required)
Operations Allowed: CRUD
Description:
Ip address of the database node, set while provisioning.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get database-node-ip-address for database-node.
Returns: | IpAddressType object |
---|
Get display-name for database-node.
Returns: | xsd:string object |
---|
Display database-node object in compact form.
Return FQN of database-node in list form.
Return FQN of database-node as colon delimited string.
Return FQN of database-node’s parent in list form.
Return FQN of database-node’s parent as colon delimted string.
Return object type (database-node).
Get id-perms for database-node.
Returns: | IdPermsType object |
---|
Get perms2 for database-node.
Returns: | PermType2 object |
---|
Bases: object
Represents discovery-service-assignment configuration representation.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
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:
Get display-name for discovery-service-assignment.
Returns: | xsd:string object |
---|
Display discovery-service-assignment object in compact form.
Return FQN of discovery-service-assignment in list form.
Return FQN of discovery-service-assignment as colon delimited string.
Return object type (discovery-service-assignment).
Get id-perms for discovery-service-assignment.
Returns: | IdPermsType object |
---|
Get perms2 for discovery-service-assignment.
Returns: | PermType2 object |
---|
Bases: object
Represents domain configuration representation.
Type: DomainLimitsType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Domain level Qouta, not currently implemented
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: System
Operations Allowed: CRUD
Description:
Project represent one instance of application or tenant.
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.
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.
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.
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:
Get display-name for domain.
Returns: | xsd:string object |
---|
Get domain-limits for domain.
Returns: | DomainLimitsType object |
---|
Display domain object in compact form.
Return FQN of domain in list form.
Return FQN of domain as colon delimited string.
Return FQN of domain’s parent in list form.
Return FQN of domain’s parent as colon delimted string.
Return object type (domain).
Get id-perms for domain.
Returns: | IdPermsType object |
---|
Get perms2 for domain.
Returns: | PermType2 object |
---|
Bases: object
Represents dsa-rule configuration representation.
Type: DiscoveryServiceAssignmentType
Created By: User (required)
Operations Allowed: CRUD
Description:
rule entry defining pubisher set and subscriber set.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for dsa-rule.
Returns: | xsd:string object |
---|
Get dsa-rule-entry for dsa-rule.
Returns: | DiscoveryServiceAssignmentType object |
---|
Display dsa-rule object in compact form.
Return FQN of dsa-rule in list form.
Return FQN of dsa-rule as colon delimited string.
Return FQN of dsa-rule’s parent in list form.
Return FQN of dsa-rule’s parent as colon delimted string.
Return object type (dsa-rule).
Get id-perms for dsa-rule.
Returns: | IdPermsType object |
---|
Get perms2 for dsa-rule.
Returns: | PermType2 object |
---|
Bases: object
Represents floating-ip configuration representation.
Type: string, one-of []
Created By: User (required)
Operations Allowed: CR
Description:
Floating ip address.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This floating ip is used as virtual ip (VIP) in case of LBaaS.
Type: string, one-of []
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.
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
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to project is which this floating ip was allocated.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to virtual machine interface to which this floating ip is attached.
Add project to floating-ip.
Parameters: | ref_obj – Project object |
---|
Add virtual-machine-interface to floating-ip.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Get display-name for floating-ip.
Returns: | xsd:string object |
---|
Display floating-ip object in compact form.
Get floating-ip-address for floating-ip.
Returns: | IpAddressType object |
---|
Get floating-ip-address-family for floating-ip.
Returns: | IpAddressFamilyType object |
---|
Get floating-ip-fixed-ip-address for floating-ip.
Returns: | IpAddressType object |
---|
Get floating-ip-is-virtual-ip for floating-ip.
Returns: | xsd:boolean object |
---|
Return list of all customer-attachments using this floating-ip
Return FQN of floating-ip in list form.
Return FQN of floating-ip as colon delimited string.
Return FQN of floating-ip’s parent in list form.
Return FQN of floating-ip’s parent as colon delimted string.
Return project list for floating-ip.
Returns: | list of <Project> |
---|
Return object type (floating-ip).
Return virtual-machine-interface list for floating-ip.
Returns: | list of <VirtualMachineInterface> |
---|
Get id-perms for floating-ip.
Returns: | IdPermsType object |
---|
Get perms2 for floating-ip.
Returns: | PermType2 object |
---|
Set project for floating-ip.
Parameters: | ref_obj – Project object |
---|
Set project list for floating-ip.
Parameters: | ref_obj_list – list of Project object |
---|
Set virtual-machine-interface for floating-ip.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for floating-ip.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Bases: object
Represents floating-ip-pool configuration representation.
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).
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
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:
Get display-name for floating-ip-pool.
Returns: | xsd:string object |
---|
Display floating-ip-pool object in compact form.
Get floating-ip-pool-prefixes for floating-ip-pool.
Returns: | FloatingIpPoolType object |
---|
Return FQN of floating-ip-pool in list form.
Return FQN of floating-ip-pool as colon delimited string.
Return FQN of floating-ip-pool’s parent in list form.
Return FQN of floating-ip-pool’s parent as colon delimted string.
Return list of all projects using this floating-ip-pool
Return object type (floating-ip-pool).
Get id-perms for floating-ip-pool.
Returns: | IdPermsType object |
---|
Get perms2 for floating-ip-pool.
Returns: | PermType2 object |
---|
Bases: object
Represents forwarding-class configuration representation.
Type: int
Created By: User (required)
Operations Allowed: CRUD
Description:
Unique ID for this forwarding class.
Type: int
Created By: User (required)
Operations Allowed: CRUD
Description:
DSCP value to be written on outgoing packet for this forwarding-class.
Type: int
Created By: User (required)
Operations Allowed: CRUD
Description:
802.1p value to be written on outgoing packet for this forwarding-class.
Type: int
Created By: User (required)
Operations Allowed: CRUD
Description:
MPLS exp value to be written on outgoing packet for this forwarding-class.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (required)
Operations Allowed: CRUD
Description:
Qos queue to be used for this forwarding class.
Referred by:
Add qos-queue to forwarding-class.
Parameters: | ref_obj – QosQueue object |
---|
Get display-name for forwarding-class.
Returns: | xsd:string object |
---|
Display forwarding-class object in compact form.
Get forwarding-class-dscp for forwarding-class.
Returns: | xsd:integer object |
---|
Get forwarding-class-id for forwarding-class.
Returns: | xsd:integer object |
---|
Get forwarding-class-mpls-exp for forwarding-class.
Returns: | xsd:integer object |
---|
Get forwarding-class-vlan-priority for forwarding-class.
Returns: | xsd:integer object |
---|
Return FQN of forwarding-class in list form.
Return FQN of forwarding-class as colon delimited string.
Return FQN of forwarding-class’s parent in list form.
Return FQN of forwarding-class’s parent as colon delimted string.
Return qos-queue list for forwarding-class.
Returns: | list of <QosQueue> |
---|
Return object type (forwarding-class).
Get id-perms for forwarding-class.
Returns: | IdPermsType object |
---|
Get perms2 for forwarding-class.
Returns: | PermType2 object |
---|
Set qos-queue for forwarding-class.
Parameters: | ref_obj – QosQueue object |
---|
Set qos-queue list for forwarding-class.
Parameters: | ref_obj_list – list of QosQueue object |
---|
Bases: object
Represents global-qos-config configuration representation.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Global system QoS config for vhost and fabric traffic .
Created By: User (optional)
Operations Allowed: CRUD
Description:
Link to global-qos config.
Created By: User (optional)
Operations Allowed: CRUD
Description:
QOS queue config object in this project.
References to:
Referred by:
Get display-name for global-qos-config.
Returns: | xsd:string object |
---|
Display global-qos-config object in compact form.
Return FQN of global-qos-config in list form.
Return FQN of global-qos-config as colon delimited string.
Return FQN of global-qos-config’s parent in list form.
Return FQN of global-qos-config’s parent as colon delimted string.
Return object type (global-qos-config).
Get id-perms for global-qos-config.
Returns: | IdPermsType object |
---|
Get perms2 for global-qos-config.
Returns: | PermType2 object |
---|
Bases: object
Represents global-system-config configuration representation.
Type: int, one-of [u‘1’, u‘65534’]
Created By: User (required)
Operations Allowed: CRUD
Description:
16 bit BGP Autonomous System number for the cluster.
Type: string
Created By: System
Operations Allowed: R
Description:
Version of OpenContrail software that generated this config.
Type: GracefulRestartType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Graceful Restart parameters
Type: PluginProperties
Created By: User (optional)
Operations Allowed: CRUD
Description:
Various Orchestration system plugin(interface) parameters, like Openstack Neutron plugin.
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.
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.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Flag to enable/disable alarms configured under global-system-config. True, if not set.
Type: UserDefinedCounterList
Created By: User (optional)
Operations Allowed: CRUD
Description:
counter name and patterns
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (required)
Operations Allowed: R
Description:
Global vrouter config is object where all global vrouter config is present.
Created By: User (required)
Operations Allowed: R
Description:
Global QoS system config is object where all global system QoS configuration is present.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual router is packet forwarding system on devices such as compute nodes(servers), TOR(s),
routers.
Created By: User (admin-only)
Operations Allowed: CRUD
Description:
Config node is object representing a logical node in system which serves config API.
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.
Created By: User (required)
Operations Allowed: CRUD
Description:
Database node is object representing a logical node in system which host Cassendra DB and Zookeeper.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of alarms that are applicable to objects anchored under global-system-config.
Created By: User (required)
Operations Allowed: R
Description:
List of references to all bgp routers in systems.
Referred by:
Add bgp-router to global-system-config.
Parameters: | ref_obj – BgpRouter object |
---|
Get alarm-enable for global-system-config.
Returns: | xsd:boolean object |
---|
Get autonomous-system for global-system-config.
Returns: | AutonomousSystemType object |
---|
Get config-version for global-system-config.
Returns: | xsd:string object |
---|
Get display-name for global-system-config.
Returns: | xsd:string object |
---|
Display global-system-config object in compact form.
Return bgp-router list for global-system-config.
Returns: | list of <BgpRouter> |
---|
Return FQN of global-system-config in list form.
Return FQN of global-system-config as colon delimited string.
Return FQN of global-system-config’s parent in list form.
Return FQN of global-system-config’s parent as colon delimted string.
Return object type (global-system-config).
Get graceful-restart-params for global-system-config.
Returns: | GracefulRestartType object |
---|
Get ibgp-auto-mesh for global-system-config.
Returns: | xsd:boolean object |
---|
Get id-perms for global-system-config.
Returns: | IdPermsType object |
---|
Get ip-fabric-subnets for global-system-config.
Returns: | SubnetListType object |
---|
Get perms2 for global-system-config.
Returns: | PermType2 object |
---|
Get plugin-tuning for global-system-config.
Returns: | PluginProperties object |
---|
Set bgp-router for global-system-config.
Parameters: | ref_obj – BgpRouter object |
---|
Set bgp-router list for global-system-config.
Parameters: | ref_obj_list – list of BgpRouter object |
---|
Get user-defined-counter for global-system-config.
Returns: | UserDefinedCounterList object |
---|
Bases: object
Represents global-vrouter-config configuration representation.
Type: EcmpHashingIncludeFields
Created By: User (optional)
Operations Allowed: CRUD
Description:
ECMP hashing config at global level.
Type: LinklocalServicesTypes
Created By: User (optional)
Operations Allowed: CRUD
Description:
Global services provided on link local subnet to the virtual machines.
Type: EncapsulationPrioritiesType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Ordered list of enapsulations that vrouter will use in priority order.
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.
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
Type: FlowAgingTimeoutList
Created By: User (optional)
Operations Allowed: CRUD
Description:
Flow aging timeout per application (protocol, port) list.
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.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for global-vrouter-config.
Returns: | xsd:string object |
---|
Display global-vrouter-config object in compact form.
Get ecmp-hashing-include-fields for global-vrouter-config.
Returns: | EcmpHashingIncludeFields object |
---|
Get encapsulation-priorities for global-vrouter-config.
Returns: | EncapsulationPrioritiesType object |
---|
Get flow-aging-timeout-list for global-vrouter-config.
Returns: | FlowAgingTimeoutList object |
---|
Get flow-export-rate for global-vrouter-config.
Returns: | xsd:integer object |
---|
Get forwarding-mode for global-vrouter-config.
Returns: | ForwardingModeType object |
---|
Return FQN of global-vrouter-config in list form.
Return FQN of global-vrouter-config as colon delimited string.
Return FQN of global-vrouter-config’s parent in list form.
Return FQN of global-vrouter-config’s parent as colon delimted string.
Return object type (global-vrouter-config).
Get id-perms for global-vrouter-config.
Returns: | IdPermsType object |
---|
Get linklocal-services for global-vrouter-config.
Returns: | LinklocalServicesTypes object |
---|
Get perms2 for global-vrouter-config.
Returns: | PermType2 object |
---|
Get vxlan-network-identifier-mode for global-vrouter-config.
Returns: | VxlanNetworkIdentifierModeType object |
---|
Bases: object
Represents instance-ip configuration representation.
Type: string, one-of []
Created By: User (required)
Operations Allowed: CRUD
Description:
Ip address value for instance ip.
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).
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.
Type: SubnetType
Created By: User (optional)
Operations Allowed: CRUD
Description:
When this instance ip is secondary ip, it can track activeness of another ip.
Type: string
Created By: System
Operations Allowed: R
Description:
This instance ip was allocated from this Subnet(UUID).
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This instance ip is secondary ip of the interface.
Type: bool
Created By: System
Operations Allowed: CRUD
Description:
This instance ip is used as service chain next hop
Type: bool
Created By: System
Operations Allowed: CRUD
Description:
This instance ip is used as service health check source ip
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to virtual network of this instance ip.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to virtual machine interface to which this instance ip is attached.
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.
Add physical-router to instance-ip.
Parameters: | ref_obj – PhysicalRouter object |
---|
Add virtual-machine-interface to instance-ip.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Add virtual-network to instance-ip.
Parameters: | ref_obj – VirtualNetwork object |
---|
Get display-name for instance-ip.
Returns: | xsd:string object |
---|
Display instance-ip object in compact form.
Return FQN of instance-ip in list form.
Return FQN of instance-ip as colon delimited string.
Return physical-router list for instance-ip.
Returns: | list of <PhysicalRouter> |
---|
Return list of all service-instances using this instance-ip
Return object type (instance-ip).
Return virtual-machine-interface list for instance-ip.
Returns: | list of <VirtualMachineInterface> |
---|
Return virtual-network list for instance-ip.
Returns: | list of <VirtualNetwork> |
---|
Get id-perms for instance-ip.
Returns: | IdPermsType object |
---|
Get instance-ip-address for instance-ip.
Returns: | IpAddressType object |
---|
Get instance-ip-family for instance-ip.
Returns: | IpAddressFamilyType object |
---|
Get instance-ip-mode for instance-ip.
Returns: | AddressMode object |
---|
Get instance-ip-secondary for instance-ip.
Returns: | xsd:boolean object |
---|
Get perms2 for instance-ip.
Returns: | PermType2 object |
---|
Get secondary-ip-tracking-ip for instance-ip.
Returns: | SubnetType object |
---|
Get service-health-check-ip for instance-ip.
Returns: | xsd:boolean object |
---|
Get service-instance-ip for instance-ip.
Returns: | xsd:boolean object |
---|
Set physical-router for instance-ip.
Parameters: | ref_obj – PhysicalRouter object |
---|
Set physical-router list for instance-ip.
Parameters: | ref_obj_list – list of PhysicalRouter object |
---|
Set virtual-machine-interface for instance-ip.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for instance-ip.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Set virtual-network for instance-ip.
Parameters: | ref_obj – VirtualNetwork object |
---|
Set virtual-network list for instance-ip.
Parameters: | ref_obj_list – list of VirtualNetwork object |
---|
Get subnet-uuid for instance-ip.
Returns: | xsd:string object |
---|
Bases: object
Represents interface-route-table configuration representation.
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.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
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.
Add service-instance to interface-route-table.
Parameters: |
|
---|
Get display-name for interface-route-table.
Returns: | xsd:string object |
---|
Display interface-route-table object in compact form.
Return FQN of interface-route-table in list form.
Return FQN of interface-route-table as colon delimited string.
Return FQN of interface-route-table’s parent in list form.
Return FQN of interface-route-table’s parent as colon delimted string.
Return service-instance list for interface-route-table.
Returns: | list of tuple <ServiceInstance, ServiceInterfaceTag> |
---|
Return object type (interface-route-table).
Return list of all virtual-machine-interfaces using this interface-route-table
Get id-perms for interface-route-table.
Returns: | IdPermsType object |
---|
Get interface-route-table-routes for interface-route-table.
Returns: | RouteTableType object |
---|
Get perms2 for interface-route-table.
Returns: | PermType2 object |
---|
Set service-instance for interface-route-table.
Parameters: |
|
---|
Set service-instance list for interface-route-table.
Parameters: |
|
---|
Bases: object
Represents loadbalancer configuration representation.
Type: LoadbalancerType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: string
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Add service-instance to loadbalancer.
Parameters: | ref_obj – ServiceInstance object |
---|
Add virtual-machine-interface to loadbalancer.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Get display-name for loadbalancer.
Returns: | xsd:string object |
---|
Display loadbalancer object in compact form.
Return FQN of loadbalancer in list form.
Return FQN of loadbalancer as colon delimited string.
Return list of all loadbalancer-listeners using this loadbalancer
Return FQN of loadbalancer’s parent in list form.
Return FQN of loadbalancer’s parent as colon delimted string.
Return service-instance list for loadbalancer.
Returns: | list of <ServiceInstance> |
---|
Return object type (loadbalancer).
Return virtual-machine-interface list for loadbalancer.
Returns: | list of <VirtualMachineInterface> |
---|
Get id-perms for loadbalancer.
Returns: | IdPermsType object |
---|
Get loadbalancer-properties for loadbalancer.
Returns: | LoadbalancerType object |
---|
Get loadbalancer-provider for loadbalancer.
Returns: | xsd:string object |
---|
Get perms2 for loadbalancer.
Returns: | PermType2 object |
---|
Set service-instance for loadbalancer.
Parameters: | ref_obj – ServiceInstance object |
---|
Set service-instance list for loadbalancer.
Parameters: | ref_obj_list – list of ServiceInstance object |
---|
Set virtual-machine-interface for loadbalancer.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for loadbalancer.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Bases: object
Represents loadbalancer-healthmonitor configuration representation.
Type: LoadbalancerHealthmonitorType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for loadbalancer-healthmonitor.
Returns: | xsd:string object |
---|
Display loadbalancer-healthmonitor object in compact form.
Return FQN of loadbalancer-healthmonitor in list form.
Return FQN of loadbalancer-healthmonitor as colon delimited string.
Return list of all loadbalancer-pools using this loadbalancer-healthmonitor
Return FQN of loadbalancer-healthmonitor’s parent in list form.
Return FQN of loadbalancer-healthmonitor’s parent as colon delimted string.
Return object type (loadbalancer-healthmonitor).
Get id-perms for loadbalancer-healthmonitor.
Returns: | IdPermsType object |
---|
Get loadbalancer-healthmonitor-properties for loadbalancer-healthmonitor.
Returns: | LoadbalancerHealthmonitorType object |
---|
Get perms2 for loadbalancer-healthmonitor.
Returns: | PermType2 object |
---|
Bases: object
Represents loadbalancer-listener configuration representation.
Type: LoadbalancerListenerType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Add loadbalancer to loadbalancer-listener.
Parameters: | ref_obj – Loadbalancer object |
---|
Get display-name for loadbalancer-listener.
Returns: | xsd:string object |
---|
Display loadbalancer-listener object in compact form.
Return FQN of loadbalancer-listener in list form.
Return FQN of loadbalancer-listener as colon delimited string.
Return list of all loadbalancer-pools using this loadbalancer-listener
Return loadbalancer list for loadbalancer-listener.
Returns: | list of <Loadbalancer> |
---|
Return FQN of loadbalancer-listener’s parent in list form.
Return FQN of loadbalancer-listener’s parent as colon delimted string.
Return object type (loadbalancer-listener).
Get id-perms for loadbalancer-listener.
Returns: | IdPermsType object |
---|
Get loadbalancer-listener-properties for loadbalancer-listener.
Returns: | LoadbalancerListenerType object |
---|
Get perms2 for loadbalancer-listener.
Returns: | PermType2 object |
---|
Set loadbalancer for loadbalancer-listener.
Parameters: | ref_obj – Loadbalancer object |
---|
Set loadbalancer list for loadbalancer-listener.
Parameters: | ref_obj_list – list of Loadbalancer object |
---|
Bases: object
Represents loadbalancer-member configuration representation.
Type: LoadbalancerMemberType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for loadbalancer-member.
Returns: | xsd:string object |
---|
Display loadbalancer-member object in compact form.
Return FQN of loadbalancer-member in list form.
Return FQN of loadbalancer-member as colon delimited string.
Return FQN of loadbalancer-member’s parent in list form.
Return FQN of loadbalancer-member’s parent as colon delimted string.
Return object type (loadbalancer-member).
Get id-perms for loadbalancer-member.
Returns: | IdPermsType object |
---|
Get loadbalancer-member-properties for loadbalancer-member.
Returns: | LoadbalancerMemberType object |
---|
Get perms2 for loadbalancer-member.
Returns: | PermType2 object |
---|
Bases: object
Represents loadbalancer-pool configuration representation.
Type: LoadbalancerPoolType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: string
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Add loadbalancer-healthmonitor to loadbalancer-pool.
Parameters: | ref_obj – LoadbalancerHealthmonitor object |
---|
Add loadbalancer-listener to loadbalancer-pool.
Parameters: | ref_obj – LoadbalancerListener object |
---|
Add service-appliance-set to loadbalancer-pool.
Parameters: | ref_obj – ServiceApplianceSet object |
---|
Add service-instance to loadbalancer-pool.
Parameters: | ref_obj – ServiceInstance object |
---|
Add virtual-machine-interface to loadbalancer-pool.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Get display-name for loadbalancer-pool.
Returns: | xsd:string object |
---|
Display loadbalancer-pool object in compact form.
Return FQN of loadbalancer-pool in list form.
Return FQN of loadbalancer-pool as colon delimited string.
Return loadbalancer-healthmonitor list for loadbalancer-pool.
Returns: | list of <LoadbalancerHealthmonitor> |
---|
Return loadbalancer-listener list for loadbalancer-pool.
Returns: | list of <LoadbalancerListener> |
---|
Return FQN of loadbalancer-pool’s parent in list form.
Return FQN of loadbalancer-pool’s parent as colon delimted string.
Return service-appliance-set list for loadbalancer-pool.
Returns: | list of <ServiceApplianceSet> |
---|
Return service-instance list for loadbalancer-pool.
Returns: | list of <ServiceInstance> |
---|
Return object type (loadbalancer-pool).
Return list of all virtual-ips using this loadbalancer-pool
Return virtual-machine-interface list for loadbalancer-pool.
Returns: | list of <VirtualMachineInterface> |
---|
Get id-perms for loadbalancer-pool.
Returns: | IdPermsType object |
---|
Get loadbalancer-pool-custom-attributes for loadbalancer-pool.
Returns: | KeyValuePairs object |
---|
Get loadbalancer-pool-properties for loadbalancer-pool.
Returns: | LoadbalancerPoolType object |
---|
Get loadbalancer-pool-provider for loadbalancer-pool.
Returns: | xsd:string object |
---|
Get perms2 for loadbalancer-pool.
Returns: | PermType2 object |
---|
Set loadbalancer-healthmonitor for loadbalancer-pool.
Parameters: | ref_obj – LoadbalancerHealthmonitor object |
---|
Set loadbalancer-healthmonitor list for loadbalancer-pool.
Parameters: | ref_obj_list – list of LoadbalancerHealthmonitor object |
---|
Set loadbalancer-listener for loadbalancer-pool.
Parameters: | ref_obj – LoadbalancerListener object |
---|
Set loadbalancer-listener list for loadbalancer-pool.
Parameters: | ref_obj_list – list of LoadbalancerListener object |
---|
Set service-appliance-set for loadbalancer-pool.
Parameters: | ref_obj – ServiceApplianceSet object |
---|
Set service-appliance-set list for loadbalancer-pool.
Parameters: | ref_obj_list – list of ServiceApplianceSet object |
---|
Set service-instance for loadbalancer-pool.
Parameters: | ref_obj – ServiceInstance object |
---|
Set service-instance list for loadbalancer-pool.
Parameters: | ref_obj_list – list of ServiceInstance object |
---|
Set virtual-machine-interface for loadbalancer-pool.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for loadbalancer-pool.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Bases: object
Represents logical-interface configuration representation.
Type: int
Created By: User (optional)
Operations Allowed: CRUD
Description:
VLAN tag (.1Q) classifier for this logical interface.
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.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
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 to logical-interface.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Get display-name for logical-interface.
Returns: | xsd:string object |
---|
Display logical-interface object in compact form.
Return FQN of logical-interface in list form.
Return FQN of logical-interface as colon delimited string.
Return FQN of logical-interface’s parent in list form.
Return FQN of logical-interface’s parent as colon delimted string.
Return object type (logical-interface).
Return virtual-machine-interface list for logical-interface.
Returns: | list of <VirtualMachineInterface> |
---|
Get id-perms for logical-interface.
Returns: | IdPermsType object |
---|
Get logical-interface-type for logical-interface.
Returns: | LogicalInterfaceType object |
---|
Get logical-interface-vlan-tag for logical-interface.
Returns: | xsd:integer object |
---|
Get perms2 for logical-interface.
Returns: | PermType2 object |
---|
Set virtual-machine-interface for logical-interface.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for logical-interface.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Bases: object
Represents logical-router configuration representation.
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.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
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.
Created By: System
Operations Allowed: CRUD
Description:
Route target that represent this logical router.
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
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.
Created By: System
Operations Allowed: CRUD
Description:
Refernce to service instance doing SNAT functionality for external gateway.
Referred by:
Add route-table to logical-router.
Parameters: | ref_obj – RouteTable object |
---|
Add route-target to logical-router.
Parameters: | ref_obj – RouteTarget object |
---|
Add service-instance to logical-router.
Parameters: | ref_obj – ServiceInstance object |
---|
Add virtual-machine-interface to logical-router.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Add virtual-network to logical-router.
Parameters: | ref_obj – VirtualNetwork object |
---|
Get configured-route-target-list for logical-router.
Returns: | RouteTargetList object |
---|
Get display-name for logical-router.
Returns: | xsd:string object |
---|
Display logical-router object in compact form.
Return FQN of logical-router in list form.
Return FQN of logical-router as colon delimited string.
Return FQN of logical-router’s parent in list form.
Return FQN of logical-router’s parent as colon delimted string.
Return route-table list for logical-router.
Returns: | list of <RouteTable> |
---|
Return route-target list for logical-router.
Returns: | list of <RouteTarget> |
---|
Return service-instance list for logical-router.
Returns: | list of <ServiceInstance> |
---|
Return object type (logical-router).
Return virtual-machine-interface list for logical-router.
Returns: | list of <VirtualMachineInterface> |
---|
Return virtual-network list for logical-router.
Returns: | list of <VirtualNetwork> |
---|
Get id-perms for logical-router.
Returns: | IdPermsType object |
---|
Get perms2 for logical-router.
Returns: | PermType2 object |
---|
Set route-table for logical-router.
Parameters: | ref_obj – RouteTable object |
---|
Set route-table list for logical-router.
Parameters: | ref_obj_list – list of RouteTable object |
---|
Set route-target for logical-router.
Parameters: | ref_obj – RouteTarget object |
---|
Set route-target list for logical-router.
Parameters: | ref_obj_list – list of RouteTarget object |
---|
Set service-instance for logical-router.
Parameters: | ref_obj – ServiceInstance object |
---|
Set service-instance list for logical-router.
Parameters: | ref_obj_list – list of ServiceInstance object |
---|
Set virtual-machine-interface for logical-router.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for logical-router.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Set virtual-network for logical-router.
Parameters: | ref_obj – VirtualNetwork object |
---|
Set virtual-network list for logical-router.
Parameters: | ref_obj_list – list of VirtualNetwork object |
---|
Bases: object
Represents namespace configuration representation.
Type: SubnetType
Created By: User (optional)
Operations Allowed: CRUD
Description:
All networks in this namespace belong to this list of Prefixes. Not implemented.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for namespace.
Returns: | xsd:string object |
---|
Display namespace object in compact form.
Return FQN of namespace in list form.
Return FQN of namespace as colon delimited string.
Return FQN of namespace’s parent in list form.
Return FQN of namespace’s parent as colon delimted string.
Return list of all projects using this namespace
Return object type (namespace).
Get id-perms for namespace.
Returns: | IdPermsType object |
---|
Get namespace-cidr for namespace.
Returns: | SubnetType object |
---|
Get perms2 for namespace.
Returns: | PermType2 object |
---|
Bases: object
Represents network-ipam configuration representation.
Type: IpamType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Network IP Address Management configuration.
Type: IpamSubnets
Created By: User (optional)
Operations Allowed: CRD
Description:
List of subnets for this ipam.
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.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to virtual DNS used by this IPAM.
Add virtual-DNS to network-ipam.
Parameters: | ref_obj – VirtualDns object |
---|
Get display-name for network-ipam.
Returns: | xsd:string object |
---|
Display network-ipam object in compact form.
Return FQN of network-ipam in list form.
Return FQN of network-ipam as colon delimited string.
Return FQN of network-ipam’s parent in list form.
Return FQN of network-ipam’s parent as colon delimted string.
Return object type (network-ipam).
Return virtual-DNS list for network-ipam.
Returns: | list of <VirtualDns> |
---|
Return list of all virtual-networks using this network-ipam
Get id-perms for network-ipam.
Returns: | IdPermsType object |
---|
Get ipam-subnet-method for network-ipam.
Returns: | SubnetMethodType object |
---|
Get ipam-subnets for network-ipam.
Returns: | IpamSubnets object |
---|
Get network-ipam-mgmt for network-ipam.
Returns: | IpamType object |
---|
Get perms2 for network-ipam.
Returns: | PermType2 object |
---|
Set virtual-DNS for network-ipam.
Parameters: | ref_obj – VirtualDns object |
---|
Set virtual-DNS list for network-ipam.
Parameters: | ref_obj_list – list of VirtualDns object |
---|
Bases: object
Represents network-policy configuration representation.
Type: PolicyEntriesType
Created By: User (required)
Operations Allowed: CRUD
Description:
Network policy rule entries.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for network-policy.
Returns: | xsd:string object |
---|
Display network-policy object in compact form.
Return FQN of network-policy in list form.
Return FQN of network-policy as colon delimited string.
Return FQN of network-policy’s parent in list form.
Return FQN of network-policy’s parent as colon delimted string.
Return object type (network-policy).
Return list of all virtual-networks using this network-policy
Get id-perms for network-policy.
Returns: | IdPermsType object |
---|
Get network-policy-entries for network-policy.
Returns: | PolicyEntriesType object |
---|
Get perms2 for network-policy.
Returns: | PermType2 object |
---|
Bases: object
Represents physical-interface configuration representation.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Logical interfaces on physical interface on physical routers.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to the other physical interface that is connected to this physical interface.
Add physical-interface to physical-interface.
Parameters: | ref_obj – PhysicalInterface object |
---|
Get display-name for physical-interface.
Returns: | xsd:string object |
---|
Display physical-interface object in compact form.
Return FQN of physical-interface in list form.
Return FQN of physical-interface as colon delimited string.
Return FQN of physical-interface’s parent in list form.
Return FQN of physical-interface’s parent as colon delimted string.
Return list of all physical-interfaces using this physical-interface
Return physical-interface list for physical-interface.
Returns: | list of <PhysicalInterface> |
---|
Return list of all service-appliances using this physical-interface
Return object type (physical-interface).
Return list of all virtual-machine-interfaces using this physical-interface
Get id-perms for physical-interface.
Returns: | IdPermsType object |
---|
Get perms2 for physical-interface.
Returns: | PermType2 object |
---|
Set physical-interface for physical-interface.
Parameters: | ref_obj – PhysicalInterface object |
---|
Set physical-interface list for physical-interface.
Parameters: | ref_obj_list – list of PhysicalInterface object |
---|
Bases: object
Represents physical-router configuration representation.
Type: string, one-of []
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.
Type: string, one-of []
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.
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.
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.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This physical router is enabled to be configured by device manager.
Type: UserCredentials
Created By: User (optional)
Operations Allowed: CRUD
Description:
Username and password for netconf to the physical router by device manager.
Type: SNMPCredentials
Created By: User (optional)
Operations Allowed: CRUD
Description:
SNMP credentials for the physical router used by SNMP colloctor.
Type: JunosServicePorts
Created By: User (optional)
Operations Allowed: CRUD
Description:
Juniper JUNOS specific sevice interfaces name to perform services like NAT.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Physical interfaces on physical routers.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Logical interfaces on physical routers.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Referance to BGP peer representing this physical router.
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.
Add bgp-router to physical-router.
Parameters: | ref_obj – BgpRouter object |
---|
Add virtual-network to physical-router.
Parameters: | ref_obj – VirtualNetwork object |
---|
Add virtual-router to physical-router.
Parameters: | ref_obj – VirtualRouter object |
---|
Get display-name for physical-router.
Returns: | xsd:string object |
---|
Display physical-router object in compact form.
Return bgp-router list for physical-router.
Returns: | list of <BgpRouter> |
---|
Return FQN of physical-router in list form.
Return FQN of physical-router as colon delimited string.
Return list of all instance-ips using this physical-router
Return FQN of physical-router’s parent in list form.
Return FQN of physical-router’s parent as colon delimted string.
Return object type (physical-router).
Return virtual-network list for physical-router.
Returns: | list of <VirtualNetwork> |
---|
Return virtual-router list for physical-router.
Returns: | list of <VirtualRouter> |
---|
Get id-perms for physical-router.
Returns: | IdPermsType object |
---|
Get perms2 for physical-router.
Returns: | PermType2 object |
---|
Get physical-router-dataplane-ip for physical-router.
Returns: | IpAddress object |
---|
Get physical-router-junos-service-ports for physical-router.
Returns: | JunosServicePorts object |
---|
Get physical-router-management-ip for physical-router.
Returns: | IpAddress object |
---|
Get physical-router-product-name for physical-router.
Returns: | xsd:string object |
---|
Get physical-router-snmp-credentials for physical-router.
Returns: | SNMPCredentials object |
---|
Get physical-router-user-credentials for physical-router.
Returns: | UserCredentials object |
---|
Get physical-router-vendor-name for physical-router.
Returns: | xsd:string object |
---|
Get physical-router-vnc-managed for physical-router.
Returns: | xsd:boolean object |
---|
Set bgp-router for physical-router.
Parameters: | ref_obj – BgpRouter object |
---|
Set bgp-router list for physical-router.
Parameters: | ref_obj_list – list of BgpRouter object |
---|
Set virtual-network for physical-router.
Parameters: | ref_obj – VirtualNetwork object |
---|
Set virtual-network list for physical-router.
Parameters: | ref_obj_list – list of VirtualNetwork object |
---|
Set virtual-router for physical-router.
Parameters: | ref_obj – VirtualRouter object |
---|
Set virtual-router list for physical-router.
Parameters: | ref_obj_list – list of VirtualRouter object |
---|
Bases: object
Represents port-tuple configuration representation.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for port-tuple.
Returns: | xsd:string object |
---|
Display port-tuple object in compact form.
Return FQN of port-tuple in list form.
Return FQN of port-tuple as colon delimited string.
Return FQN of port-tuple’s parent in list form.
Return FQN of port-tuple’s parent as colon delimted string.
Return object type (port-tuple).
Return list of all virtual-machine-interfaces using this port-tuple
Get id-perms for port-tuple.
Returns: | IdPermsType object |
---|
Get perms2 for port-tuple.
Returns: | PermType2 object |
---|
Bases: object
Represents project configuration representation.
Type: QuotaType
Created By: User (required)
Operations Allowed: CRUD
Description:
Max instances limits for various objects under project.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Flag to enable/disable alarms configured under global-system-config. True, if not set.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
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.
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.
Created By: User (optional)
Operations Allowed: CRUDQOS configuration specifying marking and queueing value for various QoS values
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
IP Address Management object that controls, ip allocation, DNS and DHCP
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.
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.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of references of child routing policy objects. automatically maintained by system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of references of child routing route aggregate objects. automatically maintained by system.
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.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Network route table is machinism of adding static routes in the virtual network
Created By: User (optional)
Operations Allowed: CRUD
Description:
Interface route table is machanism to add static routes pointing to this interface.
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.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of alarms that are applicable to objects anchored under the project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to network namespace of this project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to floating ip pool in this project.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to alias ip pool in this project.
Add alias-ip-pool to project.
Parameters: | ref_obj – AliasIpPool object |
---|
Add floating-ip-pool to project.
Parameters: | ref_obj – FloatingIpPool object |
---|
Add namespace to project.
Parameters: |
|
---|
Get alarm-enable for project.
Returns: | xsd:boolean object |
---|
Get display-name for project.
Returns: | xsd:string object |
---|
Display project object in compact form.
Return list of all alias-ips using this project
Return alias-ip-pool list for project.
Returns: | list of <AliasIpPool> |
---|
Return list of all floating-ips using this project
Return floating-ip-pool list for project.
Returns: | list of <FloatingIpPool> |
---|
Return FQN of project in list form.
Return FQN of project as colon delimited string.
Return namespace list for project.
Returns: | list of tuple <Namespace, SubnetType> |
---|
Return FQN of project’s parent in list form.
Return FQN of project’s parent as colon delimted string.
Return object type (project).
Get id-perms for project.
Returns: | IdPermsType object |
---|
Get perms2 for project.
Returns: | PermType2 object |
---|
Get quota for project.
Returns: | QuotaType object |
---|
Set alias-ip-pool for project.
Parameters: | ref_obj – AliasIpPool object |
---|
Set alias-ip-pool list for project.
Parameters: | ref_obj_list – list of AliasIpPool object |
---|
Set floating-ip-pool for project.
Parameters: | ref_obj – FloatingIpPool object |
---|
Set floating-ip-pool list for project.
Parameters: | ref_obj_list – list of FloatingIpPool object |
---|
Set namespace for project.
Parameters: |
|
---|
Set namespace list for project.
Parameters: |
|
---|
Bases: object
Represents provider-attachment configuration representation.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Not in Use.
Referred by:
Add virtual-router to provider-attachment.
Parameters: | ref_obj – VirtualRouter object |
---|
Get display-name for provider-attachment.
Returns: | xsd:string object |
---|
Display provider-attachment object in compact form.
Return FQN of provider-attachment in list form.
Return FQN of provider-attachment as colon delimited string.
Return object type (provider-attachment).
Return virtual-router list for provider-attachment.
Returns: | list of <VirtualRouter> |
---|
Get id-perms for provider-attachment.
Returns: | IdPermsType object |
---|
Get perms2 for provider-attachment.
Returns: | PermType2 object |
---|
Set virtual-router for provider-attachment.
Parameters: | ref_obj – VirtualRouter object |
---|
Set virtual-router list for provider-attachment.
Parameters: | ref_obj_list – list of VirtualRouter object |
---|
Bases: object
Represents qos-config configuration representation.
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:
Type: QosIdForwardingClassPairs
Created By: User (CRUD)
Operations Allowed: Map of DSCP match condition and applicable forwarding class for packet.
Description:
Type: QosIdForwardingClassPairs
Created By: User (CRUD)
Operations Allowed: Map of .1p priority code to applicable forwarding class for packet.
Description:
Type: QosIdForwardingClassPairs
Created By: User (CRUD)
Operations Allowed: Map of MPLS EXP values to applicable forwarding class for packet.
Description:
Type: bool
Created By: User (CRUD)
Operations Allowed: Mode specifying if QoS bits in packet should be honoured or not.
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for qos-config.
Returns: | xsd:string object |
---|
Get dscp-entries for qos-config.
Returns: | QosIdForwardingClassPairs object |
---|
Display qos-config object in compact form.
Return FQN of qos-config in list form.
Return FQN of qos-config as colon delimited string.
Return FQN of qos-config’s parent in list form.
Return FQN of qos-config’s parent as colon delimted string.
Return object type (qos-config).
Return list of all virtual-machine-interfaces using this qos-config
Return list of all virtual-networks using this qos-config
Get id-perms for qos-config.
Returns: | IdPermsType object |
---|
Get mpls-exp-entries for qos-config.
Returns: | QosIdForwardingClassPairs object |
---|
Get perms2 for qos-config.
Returns: | PermType2 object |
---|
Get qos-config-type for qos-config.
Returns: | QosConfigType object |
---|
Get trusted for qos-config.
Returns: | xsd:boolean object |
---|
Get vlan-priority-entries for qos-config.
Returns: | QosIdForwardingClassPairs object |
---|
Bases: object
Represents qos-queue configuration representation.
Type: int
Created By: User (required)
Operations Allowed: CRUD
Description:
Minimum bandwidth for this queue.
Type: int
Created By: User (required)
Operations Allowed: CRUD
Description:
Maximum bandwidth for this queue.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for qos-queue.
Returns: | xsd:string object |
---|
Display qos-queue object in compact form.
Return list of all forwarding-classs using this qos-queue
Return FQN of qos-queue in list form.
Return FQN of qos-queue as colon delimited string.
Return FQN of qos-queue’s parent in list form.
Return FQN of qos-queue’s parent as colon delimted string.
Return object type (qos-queue).
Get id-perms for qos-queue.
Returns: | IdPermsType object |
---|
Get max-bandwidth for qos-queue.
Returns: | xsd:integer object |
---|
Get min-bandwidth for qos-queue.
Returns: | xsd:integer object |
---|
Get perms2 for qos-queue.
Returns: | PermType2 object |
---|
Bases: object
Represents route-aggregate configuration representation.
Type: RouteListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: string
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to route-aggregate policy attached to (service instance, interface).
Created By: User (optional)
Operations Allowed: CRUD
Description:
Referred by:
Add routing-instance to route-aggregate.
Parameters: | ref_obj – RoutingInstance object |
---|
Add service-instance to route-aggregate.
Parameters: |
|
---|
Get aggregate-route-entries for route-aggregate.
Returns: | RouteListType object |
---|
Get aggregate-route-nexthop for route-aggregate.
Returns: | xsd:string object |
---|
Get display-name for route-aggregate.
Returns: | xsd:string object |
---|
Display route-aggregate object in compact form.
Return FQN of route-aggregate in list form.
Return FQN of route-aggregate as colon delimited string.
Return FQN of route-aggregate’s parent in list form.
Return FQN of route-aggregate’s parent as colon delimted string.
Return routing-instance list for route-aggregate.
Returns: | list of <RoutingInstance> |
---|
Return service-instance list for route-aggregate.
Returns: | list of tuple <ServiceInstance, ServiceInterfaceTag> |
---|
Return object type (route-aggregate).
Get id-perms for route-aggregate.
Returns: | IdPermsType object |
---|
Get perms2 for route-aggregate.
Returns: | PermType2 object |
---|
Set routing-instance for route-aggregate.
Parameters: | ref_obj – RoutingInstance object |
---|
Set routing-instance list for route-aggregate.
Parameters: | ref_obj_list – list of RoutingInstance object |
---|
Set service-instance for route-aggregate.
Parameters: |
|
---|
Set service-instance list for route-aggregate.
Parameters: |
|
---|
Bases: object
Represents route-table configuration representation.
Type: RouteTableType
Created By: User (required)
Operations Allowed: CRUD
Description:
Routes in the route table are configured in following way.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for route-table.
Returns: | xsd:string object |
---|
Display route-table object in compact form.
Return FQN of route-table in list form.
Return FQN of route-table as colon delimited string.
Return list of all logical-routers using this route-table
Return FQN of route-table’s parent in list form.
Return FQN of route-table’s parent as colon delimted string.
Return object type (route-table).
Return list of all virtual-networks using this route-table
Get id-perms for route-table.
Returns: | IdPermsType object |
---|
Get perms2 for route-table.
Returns: | PermType2 object |
---|
Get routes for route-table.
Returns: | RouteTableType object |
---|
Bases: object
Represents route-target configuration representation.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for route-target.
Returns: | xsd:string object |
---|
Display route-target object in compact form.
Return FQN of route-target in list form.
Return FQN of route-target as colon delimited string.
Return list of all logical-routers using this route-target
Return list of all routing-instances using this route-target
Return object type (route-target).
Get id-perms for route-target.
Returns: | IdPermsType object |
---|
Get perms2 for route-target.
Returns: | PermType2 object |
---|
Bases: object
Represents routing-instance configuration representation.
Type: ServiceChainInfo
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: ServiceChainInfo
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: StaticRouteEntriesType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: DefaultProtocolType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Add route-target to routing-instance.
Parameters: |
|
---|
Add routing-instance to routing-instance.
Parameters: |
|
---|
Get default-ce-protocol for routing-instance.
Returns: | DefaultProtocolType object |
---|
Get display-name for routing-instance.
Returns: | xsd:string object |
---|
Display routing-instance object in compact form.
Return FQN of routing-instance in list form.
Return FQN of routing-instance as colon delimited string.
Return FQN of routing-instance’s parent in list form.
Return FQN of routing-instance’s parent as colon delimted string.
Return list of all route-aggregates using this routing-instance
Return route-target list for routing-instance.
Returns: | list of tuple <RouteTarget, InstanceTargetType> |
---|
Return list of all routing-instances using this routing-instance
Return routing-instance list for routing-instance.
Returns: | list of tuple <RoutingInstance, ConnectionType> |
---|
Return list of all routing-policys using this routing-instance
Return object type (routing-instance).
Return list of all virtual-machine-interfaces using this routing-instance
Get id-perms for routing-instance.
Returns: | IdPermsType object |
---|
Get ipv6-service-chain-information for routing-instance.
Returns: | ServiceChainInfo object |
---|
Get perms2 for routing-instance.
Returns: | PermType2 object |
---|
Get routing-instance-has-pnf for routing-instance.
Returns: | xsd:boolean object |
---|
Get routing-instance-is-default for routing-instance.
Returns: | xsd:boolean object |
---|
Get service-chain-information for routing-instance.
Returns: | ServiceChainInfo object |
---|
Set route-target for routing-instance.
Parameters: |
|
---|
Set route-target list for routing-instance.
Parameters: |
|
---|
Set routing-instance for routing-instance.
Parameters: |
|
---|
Set routing-instance list for routing-instance.
Parameters: |
|
---|
Get static-route-entries for routing-instance.
Returns: | StaticRouteEntriesType object |
---|
Bases: object
Represents routing-policy configuration representation.
Type: PolicyStatementType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to routing policy attached to (service instance, interface).
Created By: User (optional)
Operations Allowed: CRUD
Description:
Referred by:
Add routing-instance to routing-policy.
Parameters: |
|
---|
Add service-instance to routing-policy.
Parameters: |
|
---|
Get display-name for routing-policy.
Returns: | xsd:string object |
---|
Display routing-policy object in compact form.
Return FQN of routing-policy in list form.
Return FQN of routing-policy as colon delimited string.
Return FQN of routing-policy’s parent in list form.
Return FQN of routing-policy’s parent as colon delimted string.
Return routing-instance list for routing-policy.
Returns: | list of tuple <RoutingInstance, RoutingPolicyType> |
---|
Return service-instance list for routing-policy.
Returns: | list of tuple <ServiceInstance, RoutingPolicyServiceInstanceType> |
---|
Return object type (routing-policy).
Get id-perms for routing-policy.
Returns: | IdPermsType object |
---|
Get perms2 for routing-policy.
Returns: | PermType2 object |
---|
Get routing-policy-entries for routing-policy.
Returns: | PolicyStatementType object |
---|
Set routing-instance for routing-policy.
Parameters: |
|
---|
Set routing-instance list for routing-policy.
Parameters: |
|
---|
Set service-instance for routing-policy.
Parameters: |
|
---|
Set service-instance list for routing-policy.
Parameters: |
|
---|
Bases: object
Represents security-group configuration representation.
Type: string
Created By: System
Operations Allowed: CR
Description:
Unique 32 bit ID automatically assigned to this security group [8M+1, 32G].
Type: int
Created By: User (optional)
Operations Allowed: CRUDUnique 32 bit user defined ID assigned to this security group [1, 8M].
Description:
Type: PolicyEntriesType
Created By: User (required)
Operations Allowed: CRUD
Description:
Security group rule entries.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: System
Operations Allowed: CRUD
Description:
port access control list is automatcally derived from all the security groups attached to port.
References to:
Get configured-security-group-id for security-group.
Returns: | xsd:integer object |
---|
Get display-name for security-group.
Returns: | xsd:string object |
---|
Display security-group object in compact form.
Return FQN of security-group in list form.
Return FQN of security-group as colon delimited string.
Return FQN of security-group’s parent in list form.
Return FQN of security-group’s parent as colon delimted string.
Return object type (security-group).
Return list of all virtual-machine-interfaces using this security-group
Get id-perms for security-group.
Returns: | IdPermsType object |
---|
Get perms2 for security-group.
Returns: | PermType2 object |
---|
Get security-group-entries for security-group.
Returns: | PolicyEntriesType object |
---|
Get security-group-id for security-group.
Returns: | xsd:string object |
---|
Bases: object
Represents service-appliance configuration representation.
Type: UserCredentials
Created By: User (optional)
Operations Allowed: CRUD
Description:
Authentication credentials for driver to access service appliance.
Type: string, one-of []
Created By: User (required)
Operations Allowed: CRUD
Description:
Manegment Ip address of the service-appliance.
Type: KeyValuePairs
Created By: User (required)
Operations Allowed: CRUD
Description:
List of Key:Value pairs used by the provider driver of this service appliance.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
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 to service-appliance.
Parameters: |
|
---|
Get display-name for service-appliance.
Returns: | xsd:string object |
---|
Display service-appliance object in compact form.
Return FQN of service-appliance in list form.
Return FQN of service-appliance as colon delimited string.
Return FQN of service-appliance’s parent in list form.
Return FQN of service-appliance’s parent as colon delimted string.
Return physical-interface list for service-appliance.
Returns: | list of tuple <PhysicalInterface, ServiceApplianceInterfaceType> |
---|
Return object type (service-appliance).
Get id-perms for service-appliance.
Returns: | IdPermsType object |
---|
Get perms2 for service-appliance.
Returns: | PermType2 object |
---|
Get service-appliance-ip-address for service-appliance.
Returns: | IpAddressType object |
---|
Get service-appliance-properties for service-appliance.
Returns: | KeyValuePairs object |
---|
Get service-appliance-user-credentials for service-appliance.
Returns: | UserCredentials object |
---|
Set physical-interface for service-appliance.
Parameters: |
|
---|
Set physical-interface list for service-appliance.
Parameters: |
|
---|
Bases: object
Represents service-appliance-set configuration representation.
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.
Type: string
Created By: User (optional)
Operations Allowed: CRUD
Description:
Name of the provider driver for this service appliance set.
Type: string
Created By: User (optional)
Operations Allowed: CRUD
Description:
High availability mode for the service appliance set, active-active or active-backup.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
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:
Get display-name for service-appliance-set.
Returns: | xsd:string object |
---|
Display service-appliance-set object in compact form.
Return FQN of service-appliance-set in list form.
Return FQN of service-appliance-set as colon delimited string.
Return list of all loadbalancer-pools using this service-appliance-set
Return FQN of service-appliance-set’s parent in list form.
Return FQN of service-appliance-set’s parent as colon delimted string.
Return list of all service-templates using this service-appliance-set
Return object type (service-appliance-set).
Get id-perms for service-appliance-set.
Returns: | IdPermsType object |
---|
Get perms2 for service-appliance-set.
Returns: | PermType2 object |
---|
Get service-appliance-driver for service-appliance-set.
Returns: | xsd:string object |
---|
Get service-appliance-ha-mode for service-appliance-set.
Returns: | xsd:string object |
---|
Get service-appliance-set-properties for service-appliance-set.
Returns: | KeyValuePairs object |
---|
Bases: object
Represents service-health-check configuration representation.
Type: ServiceHealthCheckType
Created By: User (required)
Operations Allowed: CRUD
Description:
Service health check has following fields.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to service instance using this service health check.
Add service-instance to service-health-check.
Parameters: |
|
---|
Get display-name for service-health-check.
Returns: | xsd:string object |
---|
Display service-health-check object in compact form.
Return FQN of service-health-check in list form.
Return FQN of service-health-check as colon delimited string.
Return FQN of service-health-check’s parent in list form.
Return FQN of service-health-check’s parent as colon delimted string.
Return service-instance list for service-health-check.
Returns: | list of tuple <ServiceInstance, ServiceInterfaceTag> |
---|
Return object type (service-health-check).
Return list of all virtual-machine-interfaces using this service-health-check
Get id-perms for service-health-check.
Returns: | IdPermsType object |
---|
Get perms2 for service-health-check.
Returns: | PermType2 object |
---|
Get service-health-check-properties for service-health-check.
Returns: | ServiceHealthCheckType object |
---|
Set service-instance for service-health-check.
Parameters: |
|
---|
Set service-instance list for service-health-check.
Parameters: |
|
---|
Bases: object
Represents service-instance configuration representation.
Type: ServiceInstanceType
Created By: User (required)
Operations Allowed: CRUD
Description:
Service instance configuration parameters.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Opaque key value pair for generating config for the service instance.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Port tuples are ordered set of interfaces that represent a service virtual machine or physical
device , which is part of this service instance.
Order of interfaces in port tuple is same as specified in the service template.
example SI = [(Left, Right, Management), (L, R, M), ..., (L, R, M)].
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to the service template of this service instance.
Created By: System
Operations Allowed: CRUD
Description:
Reference to ip address, which is used as nexthop pointing to (service instance, service interface).
Add instance-ip to service-instance.
Parameters: |
|
---|
Add service-template to service-instance.
Parameters: | ref_obj – ServiceTemplate object |
---|
Get display-name for service-instance.
Returns: | xsd:string object |
---|
Display service-instance object in compact form.
Return FQN of service-instance in list form.
Return FQN of service-instance as colon delimited string.
Return instance-ip list for service-instance.
Returns: | list of tuple <InstanceIp, ServiceInterfaceTag> |
---|
Return list of all interface-route-tables using this service-instance
Return list of all loadbalancers using this service-instance
Return list of all loadbalancer-pools using this service-instance
Return list of all logical-routers using this service-instance
Return FQN of service-instance’s parent in list form.
Return FQN of service-instance’s parent as colon delimted string.
Return list of all route-aggregates using this service-instance
Return list of all routing-policys using this service-instance
Return list of all service-health-checks using this service-instance
Return service-template list for service-instance.
Returns: | list of <ServiceTemplate> |
---|
Return object type (service-instance).
Return list of all virtual-machines using this service-instance
Get id-perms for service-instance.
Returns: | IdPermsType object |
---|
Get perms2 for service-instance.
Returns: | PermType2 object |
---|
Get service-instance-bindings for service-instance.
Returns: | KeyValuePairs object |
---|
Get service-instance-properties for service-instance.
Returns: | ServiceInstanceType object |
---|
Set instance-ip for service-instance.
Parameters: |
|
---|
Set instance-ip list for service-instance.
Parameters: |
|
---|
Set service-template for service-instance.
Parameters: | ref_obj – ServiceTemplate object |
---|
Set service-template list for service-instance.
Parameters: | ref_obj_list – list of ServiceTemplate object |
---|
Bases: object
Represents service-template configuration representation.
Type: ServiceTemplateType
Created By: User (required)
Operations Allowed: CRUD
Description:
Service template confurigation parameters.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to the service apliance set represented by this service template.
Add service-appliance-set to service-template.
Parameters: | ref_obj – ServiceApplianceSet object |
---|
Get display-name for service-template.
Returns: | xsd:string object |
---|
Display service-template object in compact form.
Return FQN of service-template in list form.
Return FQN of service-template as colon delimited string.
Return FQN of service-template’s parent in list form.
Return FQN of service-template’s parent as colon delimted string.
Return service-appliance-set list for service-template.
Returns: | list of <ServiceApplianceSet> |
---|
Return list of all service-instances using this service-template
Return object type (service-template).
Get id-perms for service-template.
Returns: | IdPermsType object |
---|
Get perms2 for service-template.
Returns: | PermType2 object |
---|
Get service-template-properties for service-template.
Returns: | ServiceTemplateType object |
---|
Set service-appliance-set for service-template.
Parameters: | ref_obj – ServiceApplianceSet object |
---|
Set service-appliance-set list for service-template.
Parameters: | ref_obj_list – list of ServiceApplianceSet object |
---|
Bases: object
Represents subnet configuration representation.
Type: SubnetType
Created By: User (required)
Operations Allowed: CRD
Description:
Ip prefix/length of the subnet.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Subnet belongs of the refernced virtual machine interface. This is used in CPE use case when a
subnet is reachable via the interface. It also serves as dynamic DHCP pool for host on this LAN,
where vrouter is DHCP server.
Referred by:
Add virtual-machine-interface to subnet.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Get display-name for subnet.
Returns: | xsd:string object |
---|
Display subnet object in compact form.
Return FQN of subnet in list form.
Return FQN of subnet as colon delimited string.
Return object type (subnet).
Return virtual-machine-interface list for subnet.
Returns: | list of <VirtualMachineInterface> |
---|
Get id-perms for subnet.
Returns: | IdPermsType object |
---|
Get perms2 for subnet.
Returns: | PermType2 object |
---|
Set virtual-machine-interface for subnet.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for subnet.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Get subnet-ip-prefix for subnet.
Returns: | SubnetType object |
---|
Bases: object
Represents virtual-DNS configuration representation.
Type: VirtualDnsType
Created By: User (required)
Operations Allowed: CRUD
Description:
Virtua DNS data has configuration for virtual DNS like domain, dynamic records etc.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Static DNS records in virtual DNS server.
References to:
Get display-name for virtual-DNS.
Returns: | xsd:string object |
---|
Display virtual-DNS object in compact form.
Return FQN of virtual-DNS in list form.
Return FQN of virtual-DNS as colon delimited string.
Return list of all network-ipams using this virtual-DNS
Return FQN of virtual-DNS’s parent in list form.
Return FQN of virtual-DNS’s parent as colon delimted string.
Return object type (virtual-DNS).
Get id-perms for virtual-DNS.
Returns: | IdPermsType object |
---|
Get perms2 for virtual-DNS.
Returns: | PermType2 object |
---|
Get virtual-DNS-data for virtual-DNS.
Returns: | VirtualDnsType object |
---|
Bases: object
Represents virtual-DNS-record configuration representation.
Type: VirtualDnsRecordType
Created By: User (required)
Operations Allowed: CRUD
Description:
DNS record data has configuration like type, name, ip address, loadbalancing etc.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Get display-name for virtual-DNS-record.
Returns: | xsd:string object |
---|
Display virtual-DNS-record object in compact form.
Return FQN of virtual-DNS-record in list form.
Return FQN of virtual-DNS-record as colon delimited string.
Return FQN of virtual-DNS-record’s parent in list form.
Return FQN of virtual-DNS-record’s parent as colon delimted string.
Return object type (virtual-DNS-record).
Get id-perms for virtual-DNS-record.
Returns: | IdPermsType object |
---|
Get perms2 for virtual-DNS-record.
Returns: | PermType2 object |
---|
Get virtual-DNS-record-data for virtual-DNS-record.
Returns: | VirtualDnsRecordType object |
---|
Bases: object
Represents virtual-ip configuration representation.
Type: VirtualIpType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Referred by:
Add loadbalancer-pool to virtual-ip.
Parameters: | ref_obj – LoadbalancerPool object |
---|
Add virtual-machine-interface to virtual-ip.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Get display-name for virtual-ip.
Returns: | xsd:string object |
---|
Display virtual-ip object in compact form.
Return FQN of virtual-ip in list form.
Return FQN of virtual-ip as colon delimited string.
Return loadbalancer-pool list for virtual-ip.
Returns: | list of <LoadbalancerPool> |
---|
Return FQN of virtual-ip’s parent in list form.
Return FQN of virtual-ip’s parent as colon delimted string.
Return object type (virtual-ip).
Return virtual-machine-interface list for virtual-ip.
Returns: | list of <VirtualMachineInterface> |
---|
Get id-perms for virtual-ip.
Returns: | IdPermsType object |
---|
Get perms2 for virtual-ip.
Returns: | PermType2 object |
---|
Set loadbalancer-pool for virtual-ip.
Parameters: | ref_obj – LoadbalancerPool object |
---|
Set loadbalancer-pool list for virtual-ip.
Parameters: | ref_obj_list – list of LoadbalancerPool object |
---|
Set virtual-machine-interface for virtual-ip.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for virtual-ip.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Get virtual-ip-properties for virtual-ip.
Returns: | VirtualIpType object |
---|
Bases: object
Represents virtual-machine configuration representation.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: User (optional)
Operations Allowed: CRUD
Description:
References to child interfaces this virtual machine has, this is being DEPRICATED.
Created By: System
Operations Allowed: CRUD
Description:
Reference to the service instance of this virtual machine.
Add service-instance to virtual-machine.
Parameters: | ref_obj – ServiceInstance object |
---|
Get display-name for virtual-machine.
Returns: | xsd:string object |
---|
Display virtual-machine object in compact form.
Return FQN of virtual-machine in list form.
Return FQN of virtual-machine as colon delimited string.
Return service-instance list for virtual-machine.
Returns: | list of <ServiceInstance> |
---|
Return object type (virtual-machine).
Return list of all virtual-machine-interfaces using this virtual-machine
Return list of all virtual-routers using this virtual-machine
Get id-perms for virtual-machine.
Returns: | IdPermsType object |
---|
Get perms2 for virtual-machine.
Returns: | PermType2 object |
---|
Set service-instance for virtual-machine.
Parameters: | ref_obj – ServiceInstance object |
---|
Set service-instance list for virtual-machine.
Parameters: | ref_obj_list – list of ServiceInstance object |
---|
Bases: object
Represents virtual-machine-interface configuration representation.
Type: EcmpHashingIncludeFields
Created By: User (optional)
Operations Allowed: CRUD
Description:
ECMP hashing config at global level.
Type: MacAddressesType
Created By: User (required)
Operations Allowed: CRUD
Description:
MAC address of the virtual machine interface, automatically assigned by system if not provided.
Type: DhcpOptionsListType
Created By: User (optional)
Operations Allowed: CRUD
Description:
DHCP options configuration specific to this interface.
Type: RouteTableType
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of host routes(prefixes, nexthop) that are passed to VM via DHCP.
Type: AllowedAddressPairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of (IP address, MAC) other than instance ip on this interface.
Type: VrfAssignTableType
Created By: System
Operations Allowed: CRUD
Description:
VRF assignment policy for this interface, automatically generated by system.
Type: string
Created By: User (optional)
Operations Allowed: CRUD
Description:
For openstack compatibility, not used by system.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
When True all policy checks for ingress and egress traffic from this interface are disabled. Flow
table entries are not created.
Type: VirtualMachineInterfacePropertiesType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual Machine Interface miscelenious configurations.
Type: KeyValuePairs
Created By: User (optional)
Operations Allowed: CRUD
Description:
Dictionary of arbitrary (key, value) for this interface. Neutron port bindings use this.
Type: FatFlowProtocols
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of (protocol, port number), for flows to interface with (protocol, destination port number),
vrouter will ignore source port while setting up flow and ignore it as source port in reverse flow.
Hence many flows will map to single flow.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to QoS config for this virtual machine interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Interface ACL, Automatically generated by system based on security groups attached to this
interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of references to the sub interfaces of this interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
This interface belongs to the referenced virtual machine.
Created By: User (required)
Operations Allowed: CRUD
Description:
This interface is member of the referenced virtual network.
Created By: System
Operations Allowed: CRUD
Description:
Automatically generated Forwarding policy. This will be depricated in future in favour of VRF assign
rules.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Ordered set of references to the interfaces in this port tuple.
Order is same as specified in the service interface.
example (left, right, manegement, other1).
Created By: User (optional)
Operations Allowed: CRUD
Description:
Refernce to health check object attached to this interface.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to the interface route table attached to this interface.
Created By: System
Operations Allowed: CRUD
Description:
Reference to the physical interface of service appliance this service interface represents.
Add interface-route-table to virtual-machine-interface.
Parameters: | ref_obj – InterfaceRouteTable object |
---|
Add physical-interface to virtual-machine-interface.
Parameters: | ref_obj – PhysicalInterface object |
---|
Add port-tuple to virtual-machine-interface.
Parameters: | ref_obj – PortTuple object |
---|
Add qos-config to virtual-machine-interface.
Parameters: | ref_obj – QosConfig object |
---|
Add routing-instance to virtual-machine-interface.
Parameters: |
|
---|
Add security-group to virtual-machine-interface.
Parameters: | ref_obj – SecurityGroup object |
---|
Add service-health-check to virtual-machine-interface.
Parameters: | ref_obj – ServiceHealthCheck object |
---|
Add virtual-machine to virtual-machine-interface.
Parameters: | ref_obj – VirtualMachine object |
---|
Add virtual-machine-interface to virtual-machine-interface.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Add virtual-network to virtual-machine-interface.
Parameters: | ref_obj – VirtualNetwork object |
---|
Get display-name for virtual-machine-interface.
Returns: | xsd:string object |
---|
Display virtual-machine-interface object in compact form.
Get ecmp-hashing-include-fields for virtual-machine-interface.
Returns: | EcmpHashingIncludeFields object |
---|
Return list of all alias-ips using this virtual-machine-interface
Return list of all bgp-as-a-services using this virtual-machine-interface
Return list of all customer-attachments using this virtual-machine-interface
Return list of all floating-ips using this virtual-machine-interface
Return FQN of virtual-machine-interface in list form.
Return FQN of virtual-machine-interface as colon delimited string.
Return list of all instance-ips using this virtual-machine-interface
Return interface-route-table list for virtual-machine-interface.
Returns: | list of <InterfaceRouteTable> |
---|
Return list of all loadbalancers using this virtual-machine-interface
Return list of all loadbalancer-pools using this virtual-machine-interface
Return list of all logical-interfaces using this virtual-machine-interface
Return list of all logical-routers using this virtual-machine-interface
Return FQN of virtual-machine-interface’s parent in list form.
Return FQN of virtual-machine-interface’s parent as colon delimted string.
Return physical-interface list for virtual-machine-interface.
Returns: | list of <PhysicalInterface> |
---|
Return port-tuple list for virtual-machine-interface.
Returns: | list of <PortTuple> |
---|
Return qos-config list for virtual-machine-interface.
Returns: | list of <QosConfig> |
---|
Return routing-instance list for virtual-machine-interface.
Returns: | list of tuple <RoutingInstance, PolicyBasedForwardingRuleType> |
---|
Return security-group list for virtual-machine-interface.
Returns: | list of <SecurityGroup> |
---|
Return service-health-check list for virtual-machine-interface.
Returns: | list of <ServiceHealthCheck> |
---|
Return list of all subnets using this virtual-machine-interface
Return object type (virtual-machine-interface).
Return list of all virtual-ips using this virtual-machine-interface
Return list of all virtual-machine-interfaces using this virtual-machine-interface
Return virtual-machine-interface list for virtual-machine-interface.
Returns: | list of <VirtualMachineInterface> |
---|
Return virtual-machine list for virtual-machine-interface.
Returns: | list of <VirtualMachine> |
---|
Return virtual-network list for virtual-machine-interface.
Returns: | list of <VirtualNetwork> |
---|
Get id-perms for virtual-machine-interface.
Returns: | IdPermsType object |
---|
Get perms2 for virtual-machine-interface.
Returns: | PermType2 object |
---|
Set interface-route-table for virtual-machine-interface.
Parameters: | ref_obj – InterfaceRouteTable object |
---|
Set interface-route-table list for virtual-machine-interface.
Parameters: | ref_obj_list – list of InterfaceRouteTable object |
---|
Set physical-interface for virtual-machine-interface.
Parameters: | ref_obj – PhysicalInterface object |
---|
Set physical-interface list for virtual-machine-interface.
Parameters: | ref_obj_list – list of PhysicalInterface object |
---|
Set port-tuple for virtual-machine-interface.
Parameters: | ref_obj – PortTuple object |
---|
Set port-tuple list for virtual-machine-interface.
Parameters: | ref_obj_list – list of PortTuple object |
---|
Set qos-config for virtual-machine-interface.
Parameters: | ref_obj – QosConfig object |
---|
Set qos-config list for virtual-machine-interface.
Parameters: | ref_obj_list – list of QosConfig object |
---|
Set routing-instance for virtual-machine-interface.
Parameters: |
|
---|
Set routing-instance list for virtual-machine-interface.
Parameters: |
|
---|
Set security-group for virtual-machine-interface.
Parameters: | ref_obj – SecurityGroup object |
---|
Set security-group list for virtual-machine-interface.
Parameters: | ref_obj_list – list of SecurityGroup object |
---|
Set service-health-check for virtual-machine-interface.
Parameters: | ref_obj – ServiceHealthCheck object |
---|
Set service-health-check list for virtual-machine-interface.
Parameters: | ref_obj_list – list of ServiceHealthCheck object |
---|
Set virtual-machine for virtual-machine-interface.
Parameters: | ref_obj – VirtualMachine object |
---|
Set virtual-machine-interface for virtual-machine-interface.
Parameters: | ref_obj – VirtualMachineInterface object |
---|
Set virtual-machine-interface list for virtual-machine-interface.
Parameters: | ref_obj_list – list of VirtualMachineInterface object |
---|
Set virtual-machine list for virtual-machine-interface.
Parameters: | ref_obj_list – list of VirtualMachine object |
---|
Set virtual-network for virtual-machine-interface.
Parameters: | ref_obj – VirtualNetwork object |
---|
Set virtual-network list for virtual-machine-interface.
Parameters: | ref_obj_list – list of VirtualNetwork object |
---|
Get virtual-machine-interface-allowed-address-pairs for virtual-machine-interface.
Returns: | AllowedAddressPairs object |
---|
Get virtual-machine-interface-bindings for virtual-machine-interface.
Returns: | KeyValuePairs object |
---|
Get virtual-machine-interface-device-owner for virtual-machine-interface.
Returns: | xsd:string object |
---|
Get virtual-machine-interface-dhcp-option-list for virtual-machine-interface.
Returns: | DhcpOptionsListType object |
---|
Get virtual-machine-interface-disable-policy for virtual-machine-interface.
Returns: | xsd:boolean object |
---|
Get virtual-machine-interface-fat-flow-protocols for virtual-machine-interface.
Returns: | FatFlowProtocols object |
---|
Get virtual-machine-interface-host-routes for virtual-machine-interface.
Returns: | RouteTableType object |
---|
Get virtual-machine-interface-mac-addresses for virtual-machine-interface.
Returns: | MacAddressesType object |
---|
Get virtual-machine-interface-properties for virtual-machine-interface.
Returns: | VirtualMachineInterfacePropertiesType object |
---|
Get vrf-assign-table for virtual-machine-interface.
Returns: | VrfAssignTableType object |
---|
Bases: object
Represents virtual-network configuration representation.
Type: EcmpHashingIncludeFields
Created By: User (optional)
Operations Allowed: CRUD
Description:
ECMP hashing config at global level.
Type: VirtualNetworkType
Created By: User (optional)
Operations Allowed: CRUD
Description:
Virtual network miscelenious configurations.
Type: ProviderDetails
Created By: User (optional)
Operations Allowed: CRD
Description:
Virtual network is provider network. Specifies VLAN tag and physical network name.
Type: int
Created By: System
Operations Allowed: CR
Description:
System assigned unique 32 bit ID for every virtual network.
Type: RouteTargetList
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of route targets that are used as both import and export for this virtual network.
Type: RouteTargetList
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of route targets that are used as import for this virtual network.
Type: RouteTargetList
Created By: User (optional)
Operations Allowed: CRUD
Description:
List of route targets that are used as export for this virtual network.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
When true, this virtual network is openstack router external network.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
When true, this virtual network is shared with all tenants.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
IP address assignment to VM is done statically, outside of (external to) Contrail Ipam. vCenter only
feature.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
When true, packets with unknown unicast MAC addres are flooded within the network. Default they are
dropped.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
Allow multiple service chains within same two networks based on network policy.
Current limitation is that both networks must reside within cluster, except when right most service
is NAT.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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.
Created By: System
Operations Allowed: CRUD
Description:
Virtual network access control list are automatically derived from all the network policies attached
to virtual network.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Floating ip pool is set of ip address that are carved out of a given network. Ip(s) from this set
can be assigned to (virtual machine interface, ip) so that they become members of this network using
one:one NAT.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Alias ip pool is set of addresses that are carved out of a given network. Ip(s) from this set can be
assigned to virtual-machine-interface so that they become members of this network
Created By: System
Operations Allowed: CRUD
Description:
List of references of routing instances for this virtual network, routing instances are internal to
the system.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to QoS configuration for this virtual network.
Created By: User (required)
Operations Allowed: CRUD
Description:
Reference to network-ipam this network is using. It has list of subnets that are being used as
property of the refernce.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Reference to network-policy attached to this network. It has sequence number to specify attachment
order.
Created By: User (optional)
Operations Allowed: CRUD
Description:
Refernce to route table attached to this virtual network.
Add network-ipam to virtual-network.
Parameters: |
|
---|
Add network-policy to virtual-network.
Parameters: |
|
---|
Add qos-config to virtual-network.
Parameters: | ref_obj – QosConfig object |
---|
Add route-table to virtual-network.
Parameters: | ref_obj – RouteTable object |
---|
Get display-name for virtual-network.
Returns: | xsd:string object |
---|
Display virtual-network object in compact form.
Get ecmp-hashing-include-fields for virtual-network.
Returns: | EcmpHashingIncludeFields object |
---|
Get export-route-target-list for virtual-network.
Returns: | RouteTargetList object |
---|
Get external-ipam for virtual-network.
Returns: | xsd:boolean object |
---|
Get flood-unknown-unicast for virtual-network.
Returns: | xsd:boolean object |
---|
Return FQN of virtual-network in list form.
Return FQN of virtual-network as colon delimited string.
Return list of all instance-ips using this virtual-network
Return list of all logical-routers using this virtual-network
Return network-ipam list for virtual-network.
Returns: | list of tuple <NetworkIpam, VnSubnetsType> |
---|
Return network-policy list for virtual-network.
Returns: | list of tuple <NetworkPolicy, VirtualNetworkPolicyType> |
---|
Return FQN of virtual-network’s parent in list form.
Return FQN of virtual-network’s parent as colon delimted string.
Return list of all physical-routers using this virtual-network
Return qos-config list for virtual-network.
Returns: | list of <QosConfig> |
---|
Return route-table list for virtual-network.
Returns: | list of <RouteTable> |
---|
Return object type (virtual-network).
Return list of all virtual-machine-interfaces using this virtual-network
Get id-perms for virtual-network.
Returns: | IdPermsType object |
---|
Get import-route-target-list for virtual-network.
Returns: | RouteTargetList object |
---|
Get is-shared for virtual-network.
Returns: | xsd:boolean object |
---|
Get multi-policy-service-chains-enabled for virtual-network.
Returns: | xsd:boolean object |
---|
Get perms2 for virtual-network.
Returns: | PermType2 object |
---|
Get provider-properties for virtual-network.
Returns: | ProviderDetails object |
---|
Get route-target-list for virtual-network.
Returns: | RouteTargetList object |
---|
Get router-external for virtual-network.
Returns: | xsd:boolean object |
---|
Set network-ipam for virtual-network.
Parameters: |
|
---|
Set network-ipam list for virtual-network.
Parameters: |
|
---|
Set network-policy for virtual-network.
Parameters: |
|
---|
Set network-policy list for virtual-network.
Parameters: |
|
---|
Set qos-config for virtual-network.
Parameters: | ref_obj – QosConfig object |
---|
Set qos-config list for virtual-network.
Parameters: | ref_obj_list – list of QosConfig object |
---|
Set route-table for virtual-network.
Parameters: | ref_obj – RouteTable object |
---|
Set route-table list for virtual-network.
Parameters: | ref_obj_list – list of RouteTable object |
---|
Get virtual-network-network-id for virtual-network.
Returns: | xsd:integer object |
---|
Get virtual-network-properties for virtual-network.
Returns: | VirtualNetworkType object |
---|
Bases: object
Represents virtual-router configuration representation.
Type: string, one-of [u’embedded’, u’tor-agent’, u’tor-service-node’]
Created By: User (optional)
Operations Allowed: CRD
Description:
Different types of the vrouters in the system.
Type: bool
Created By: User (optional)
Operations Allowed: CRUD
Description:
This vrouter’s data path is using DPDK librarry, Virtual machines interfaces scheduled on this
compute node will be tagged with aditional flags so that they are spawned with user space virtio
driver. It is only applicable for embedded vrouter.
Type: string, one-of []
Created By: User (required)
Operations Allowed: CRUD
Description:
Ip address of the virtual router.
Type: IdPermsType
Created By: System
Operations Allowed: R
Description:
System maintained identity, time and permissions data.
Type: PermType2
Created By: System
Operations Allowed: R
Description:
Permissions data for role based access.
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:
Created By: User (optional)
Operations Allowed: CRUD
Description:
References to all virtual machines on this vrouter. This link is not present for dynamically
scheduled VMs by Nova.
Add virtual-machine to virtual-router.
Parameters: | ref_obj – VirtualMachine object |
---|
Get display-name for virtual-router.
Returns: | xsd:string object |
---|
Display virtual-router object in compact form.
Return FQN of virtual-router in list form.
Return FQN of virtual-router as colon delimited string.
Return FQN of virtual-router’s parent in list form.
Return FQN of virtual-router’s parent as colon delimted string.
Return list of all physical-routers using this virtual-router
Return list of all provider-attachments using this virtual-router
Return object type (virtual-router).
Return virtual-machine list for virtual-router.
Returns: | list of <VirtualMachine> |
---|
Get id-perms for virtual-router.
Returns: | IdPermsType object |
---|
Get perms2 for virtual-router.
Returns: | PermType2 object |
---|
Set virtual-machine for virtual-router.
Parameters: | ref_obj – VirtualMachine object |
---|
Set virtual-machine list for virtual-router.
Parameters: | ref_obj_list – list of VirtualMachine object |
---|
Get virtual-router-dpdk-enabled for virtual-router.
Returns: | xsd:boolean object |
---|
Get virtual-router-ip-address for virtual-router.
Returns: | IpAddressType object |
---|
Get virtual-router-type for virtual-router.
Returns: | VirtualRouterType object |
---|