Auto generated from API Specifications for 20.10.7

doc/v6/nuenterprise.rst

@@ -124,6 +124,8 @@ Children
 :ref:`nugatewayslocation.NUGatewaysLocation<nugatewayslocation>`                                                                                                 ``gateways_locations`` 
 :ref:`nugatewaytemplate.NUGatewayTemplate<nugatewaytemplate>`                                                                                                    ``gateway_templates`` 
 :ref:`nupatnatpool.NUPATNATPool<nupatnatpool>`                                                                                                                   ``patnat_pools`` 
+:ref:`nuscheduledtestsuite.NUScheduledTestSuite<nuscheduledtestsuite>`                                                                                           ``scheduled_test_suites`` 
+:ref:`nuicmpechotestdefinition.NUICMPEchoTestDefinition<nuicmpechotestdefinition>`                                                                               ``icmp_echo_test_definitions`` 
 :ref:`nuldapconfiguration.NULDAPConfiguration<nuldapconfiguration>`                                                                                              ``ldap_configurations`` 
 :ref:`nuidpprofile.NUIDPProfile<nuidpprofile>`                                                                                                                   ``idp_profiles`` 
 :ref:`nuwebcategory.NUWebCategory<nuwebcategory>`                                                                                                                ``web_categories`` 

doc/v6/nuenterpriseprofile.rst

@@ -48,6 +48,8 @@ Attributes
 
 - ``enable_application_performance_management``: Enable DPI for this enterprise
 
+- ``enable_oam_connectivity_statistics_collection``: Enables the collection of OAM Connectivity Statistics in the Elastic DB.
+
 - ``encryption_management_mode``: encryption management mode for this enterprise Possible values are DISABLED, MANAGED, .
 
 - ``entity_scope``: Specify if scope of entity is Data center or Enterprise level

doc/v6/nuglobalmetadata.rst

@@ -92,7 +92,7 @@ Parents
 
 - :ref:`nuredundancygroup.NURedundancyGroup<nuredundancygroup>`
 
-- :ref:`nuconnectionendpoint.NUConnectionendpoint<nuconnectionendpoint>`
+- :ref:`nuegressaclentrytemplate.NUEgressACLEntryTemplate<nuegressaclentrytemplate>`
 
 - :ref:`nutca.NUTCA<nutca>`
 
@@ -140,6 +140,8 @@ Parents
 
 - :ref:`nuipreservation.NUIPReservation<nuipreservation>`
 
+- :ref:`nuconnectionendpoint.NUConnectionendpoint<nuconnectionendpoint>`
+
 - :ref:`nuredirectiontargettemplate.NURedirectionTargetTemplate<nuredirectiontargettemplate>`
 
 - :ref:`nusubnettemplate.NUSubnetTemplate<nusubnettemplate>`
@@ -312,8 +314,6 @@ Parents
 
 - :ref:`nunetworkmacrogroup.NUNetworkMacroGroup<nunetworkmacrogroup>`
 
-- :ref:`nuegressaclentrytemplate.NUEgressACLEntryTemplate<nuegressaclentrytemplate>`
-
 - :ref:`nugnmisession.NUGNMISession<nugnmisession>`
 
 - :ref:`nudestinationurl.NUDestinationurl<nudestinationurl>`
@@ -342,8 +342,6 @@ Parents
 
 - :ref:`nuospfinterface.NUOSPFInterface<nuospfinterface>`
 
-- :ref:`nuvmipreservation.NUVMIPReservation<nuvmipreservation>`
-
 - :ref:`nuaddressmap.NUAddressMap<nuaddressmap>`
 
 - :ref:`nuunderlay.NUUnderlay<nuunderlay>`
@@ -456,6 +454,8 @@ Parents
 
 - :ref:`nudeploymentfailure.NUDeploymentFailure<nudeploymentfailure>`
 
+- :ref:`nuvmipreservation.NUVMIPReservation<nuvmipreservation>`
+
 - :ref:`nunsgroutingpolicybinding.NUNSGRoutingPolicyBinding<nunsgroutingpolicybinding>`
 
 - :ref:`nuredirectiontarget.NURedirectionTarget<nuredirectiontarget>`

doc/v6/nuicmpechotestdefinition.rst

@@ -0,0 +1,47 @@
+.. _nuicmpechotestdefinition:
+
+nuicmpechotestdefinition
+===========================================
+
+.. class:: nuicmpechotestdefinition.NUICMPEchoTestDefinition(bambou.nurest_object.NUMetaRESTObject,):
+
+ICMP Echo Test Definition describes the ICMP ping command with parameters to run inside a namespace on NSGateway. This command will be run as per the schedule specified on the Scheduled Test Suite along with the other commands in that suite.
+
+
+Attributes
+----------
+
+
+- ``packet_count``: Specifies the number of echo requests to be sent.
+
+- ``packet_interval``: Delay in milliseconds between the probes.
+
+- ``packet_size``: Specifies the number of data bytes to be sent.
+
+- ``name`` (**Mandatory**): A descriptive name for the ICMP Echo Test Definition instance.
+
+- ``description``: Description of the ICMP Echo Test Definition instance.
+
+- ``threshold_average_round_trip_time``: The threshold average round trip time KPI in milliseconds that will be monitored when SLA monitoring is enabled.
+
+- ``threshold_packet_loss``: The threshold packet loss percentage KPI to be monitored when SLA monitoring is enabled.
+
+- ``timeout``: Timeout value, in seconds, for the test until the system considers it as failed.
+
+- ``sla_monitoring``: Enables or disables the SLA monitoring.
+
+- ``donot_fragment``: Sets the Don't Fragment flag when enabled. When an IP datagram has its DF flag set, intermediate devices are not allowed to fragment it so if it needs to travel across a network with a MTU smaller that datagram length, the datagram will be dropped.
+
+- ``tos``: This field is used to carry information to provide quality of service features. It is normally used to support Differentiated Services.
+
+
+
+
+
+
+Parents
+--------
+
+
+- :ref:`nuenterprise.NUEnterprise<nuenterprise>`
+

doc/v6/numetadata.rst

@@ -90,7 +90,7 @@ Parents
 
 - :ref:`nuredundancygroup.NURedundancyGroup<nuredundancygroup>`
 
-- :ref:`nuconnectionendpoint.NUConnectionendpoint<nuconnectionendpoint>`
+- :ref:`nuegressaclentrytemplate.NUEgressACLEntryTemplate<nuegressaclentrytemplate>`
 
 - :ref:`nutca.NUTCA<nutca>`
 
@@ -138,6 +138,8 @@ Parents
 
 - :ref:`nuipreservation.NUIPReservation<nuipreservation>`
 
+- :ref:`nuconnectionendpoint.NUConnectionendpoint<nuconnectionendpoint>`
+
 - :ref:`nuredirectiontargettemplate.NURedirectionTargetTemplate<nuredirectiontargettemplate>`
 
 - :ref:`nusubnettemplate.NUSubnetTemplate<nusubnettemplate>`
@@ -310,8 +312,6 @@ Parents
 
 - :ref:`nunetworkmacrogroup.NUNetworkMacroGroup<nunetworkmacrogroup>`
 
-- :ref:`nuegressaclentrytemplate.NUEgressACLEntryTemplate<nuegressaclentrytemplate>`
-
 - :ref:`nugnmisession.NUGNMISession<nugnmisession>`
 
 - :ref:`nudestinationurl.NUDestinationurl<nudestinationurl>`
@@ -340,8 +340,6 @@ Parents
 
 - :ref:`nuospfinterface.NUOSPFInterface<nuospfinterface>`
 
-- :ref:`nuvmipreservation.NUVMIPReservation<nuvmipreservation>`
-
 - :ref:`nuaddressmap.NUAddressMap<nuaddressmap>`
 
 - :ref:`nuunderlay.NUUnderlay<nuunderlay>`
@@ -454,6 +452,8 @@ Parents
 
 - :ref:`nudeploymentfailure.NUDeploymentFailure<nudeploymentfailure>`
 
+- :ref:`nuvmipreservation.NUVMIPReservation<nuvmipreservation>`
+
 - :ref:`nunsgroutingpolicybinding.NUNSGRoutingPolicyBinding<nunsgroutingpolicybinding>`
 
 - :ref:`nuredirectiontarget.NURedirectionTarget<nuredirectiontarget>`

doc/v6/nunsgateway.rst

@@ -5,7 +5,7 @@ nunsgateway
 
 .. class:: nunsgateway.NUNSGateway(bambou.nurest_object.NUMetaRESTObject,):
 
-Network Services Gateways are a policy enforcement end-points responsible for the delivery of networking services. NSG access ports/VLANs may be attached to existing host or bridge VPorts.
+Network Services Gateways are a policy enforcement end-points responsible for the delivery of networking services. NSG access ports/VLANs may be attached to existing host or bridge vPorts.
 
 
 Attributes

doc/v6/nupermission.rst

@@ -109,7 +109,7 @@ Parents
 
 - :ref:`nuredundancygroup.NURedundancyGroup<nuredundancygroup>`
 
-- :ref:`nuconnectionendpoint.NUConnectionendpoint<nuconnectionendpoint>`
+- :ref:`nuegressaclentrytemplate.NUEgressACLEntryTemplate<nuegressaclentrytemplate>`
 
 - :ref:`nutca.NUTCA<nutca>`
 
@@ -157,6 +157,8 @@ Parents
 
 - :ref:`nuipreservation.NUIPReservation<nuipreservation>`
 
+- :ref:`nuconnectionendpoint.NUConnectionendpoint<nuconnectionendpoint>`
+
 - :ref:`nuredirectiontargettemplate.NURedirectionTargetTemplate<nuredirectiontargettemplate>`
 
 - :ref:`nusubnettemplate.NUSubnetTemplate<nusubnettemplate>`
@@ -329,8 +331,6 @@ Parents
 
 - :ref:`nunetworkmacrogroup.NUNetworkMacroGroup<nunetworkmacrogroup>`
 
-- :ref:`nuegressaclentrytemplate.NUEgressACLEntryTemplate<nuegressaclentrytemplate>`
-
 - :ref:`nudestinationurl.NUDestinationurl<nudestinationurl>`
 
 - :ref:`nuvnfcatalog.NUVNFCatalog<nuvnfcatalog>`
@@ -357,8 +357,6 @@ Parents
 
 - :ref:`nuospfinterface.NUOSPFInterface<nuospfinterface>`
 
-- :ref:`nuvmipreservation.NUVMIPReservation<nuvmipreservation>`
-
 - :ref:`nuaddressmap.NUAddressMap<nuaddressmap>`
 
 - :ref:`nuunderlay.NUUnderlay<nuunderlay>`
@@ -467,6 +465,8 @@ Parents
 
 - :ref:`nudeploymentfailure.NUDeploymentFailure<nudeploymentfailure>`
 
+- :ref:`nuvmipreservation.NUVMIPReservation<nuvmipreservation>`
+
 - :ref:`nunsgroutingpolicybinding.NUNSGRoutingPolicyBinding<nunsgroutingpolicybinding>`
 
 - :ref:`nuredirectiontarget.NURedirectionTarget<nuredirectiontarget>`

doc/v6/nuroutingpolicy.rst

@@ -24,6 +24,8 @@ Attributes
 
 - ``policy_definition``: String blob
 
+- ``policy_unique_id``: 15-digit ID to uniquely identify Routing Policies.
+
 - ``content_type``: Content type for routing policy provisioning for different mediation devices
 
 - ``routing_protocol``: Routing protocol this policy definition is used for

doc/v6/nuscheduledtestsuite.rst

@@ -0,0 +1,47 @@
+.. _nuscheduledtestsuite:
+
+nuscheduledtestsuite
+===========================================
+
+.. class:: nuscheduledtestsuite.NUScheduledTestSuite(bambou.nurest_object.NUMetaRESTObject,):
+
+A Scheduled Test Suite is grouping of a number of ICMP Echo Tests that can be run at the specified schedule, consecutively from a given source (NSGateway or VPort) toward a specified destination.
+
+
+Attributes
+----------
+
+
+- ``name`` (**Mandatory**): Name of the scheduled test suite instance.
+
+- ``schedule_interval``: This is the interval between all test runs in this suite and the next run of tests in this suite.
+
+- ``schedule_interval_units``: The units for the specified interval. This can be minutes, hours or days.
+
+- ``description``: Description for the scheduled test suite instance.
+
+- ``end_date_time``: The date and time by which this suite will be terminated. If this is not specified the tests will continue to run at the specified frequency.
+
+- ``start_date_time``: The date and time when this suite will start on the NSGateway.
+
+
+
+
+Children
+--------
+
+================================================================================================================================================               ==========================================================================================
+**class**                                                                                                                                                      **fetcher**
+
+:ref:`nuscheduledtestsuiterun.NUScheduledtestsuiterun<nuscheduledtestsuiterun>`                                                                                  ``scheduledtestsuiteruns`` 
+:ref:`nutest.NUTest<nutest>`                                                                                                                                     ``tests`` 
+================================================================================================================================================               ==========================================================================================
+
+
+
+Parents
+--------
+
+
+- :ref:`nuenterprise.NUEnterprise<nuenterprise>`
+

doc/v6/nuscheduledtestsuiterun.rst

@@ -0,0 +1,72 @@
+.. _nuscheduledtestsuiterun:
+
+nuscheduledtestsuiterun
+===========================================
+
+.. class:: nuscheduledtestsuiterun.NUScheduledtestsuiterun(bambou.nurest_object.NUMetaRESTObject,):
+
+A Scheduled Test Suite Run represents the execution of a given Scheduled Test Suite within a namespace on an NSG. It groups together multiple ICMP Echo Test Runs.
+
+
+Attributes
+----------
+
+
+- ``vport_name``: VPort name against which the test suite is executed.
+
+- ``ns_gateway_name``: Name of the NSG on which the suite will be executed.
+
+- ``mac_address``: MAC address for the interface in the namespace on the NSG.
+
+- ``datapath_id``: DatapathID of the NSG against which the tests are to be executed.
+
+- ``secondary_datapath_id``: The datapath ID of the secondary gateway in the Redundant Group.
+
+- ``secondary_ns_gateway_name``: The NSGateway name of the secondary gateway in the Redundant Group.
+
+- ``secondary_system_id``: The system ID of the secondary gateway in the Redundant Group.
+
+- ``destination``: Either an IPv4 address or FQDN to be used in conjunction with the ICMP echo test. If provided, this destination will override the destination at individual Test level.
+
+- ``vlan_id``: VLAN ID of the interface in the namespace on NSG.
+
+- ``domain_name``: Domain name within which the source vPort being tested resides.
+
+- ``zone_name``: Zone name within which the source vPort being tested resides.
+
+- ``operation_status``: The status of the test operation request received by the NSG agent.
+
+- ``vport_port_name``: The access port of the VPort against which the test suite is executed.
+
+- ``vport_vlan_id``: The VLAN ID of the VPort against which the test suite is executed.
+
+- ``associated_scheduled_test_suite_id``: The ID of the Scheduled Test Suite from which this instance of run was created.
+
+- ``associated_scheduled_test_suite_name``: Name of the Scheduled Test Suite from which this run was created.
+
+- ``subnet_name``: Subnet name within which the source vPort being tested resides.
+
+- ``system_id``: System ID of the NSG against which the tests are to be executed.
+
+
+
+
+Children
+--------
+
+================================================================================================================================================               ==========================================================================================
+**class**                                                                                                                                                      **fetcher**
+
+:ref:`nutestrun.NUTestRun<nutestrun>`                                                                                                                            ``test_runs`` 
+================================================================================================================================================               ==========================================================================================
+
+
+
+Parents
+--------
+
+
+- :ref:`nuvport.NUVPort<nuvport>`
+
+- :ref:`nuscheduledtestsuite.NUScheduledTestSuite<nuscheduledtestsuite>`
+

doc/v6/nustatistics.rst

@@ -48,6 +48,8 @@ Parents
 
 - :ref:`nuingressadvfwdentrytemplate.NUIngressAdvFwdEntryTemplate<nuingressadvfwdentrytemplate>`
 
+- :ref:`nuegressaclentrytemplate.NUEgressACLEntryTemplate<nuegressaclentrytemplate>`
+
 - :ref:`nuzone.NUZone<nuzone>`
 
 - :ref:`nupatnatpool.NUPATNATPool<nupatnatpool>`
@@ -66,8 +68,6 @@ Parents
 
 - :ref:`nunsport.NUNSPort<nunsport>`
 
-- :ref:`nuegressaclentrytemplate.NUEgressACLEntryTemplate<nuegressaclentrytemplate>`
-
 - :ref:`nudomain.NUDomain<nudomain>`
 
 - :ref:`nubridgeinterface.NUBridgeInterface<nubridgeinterface>`