update docs for 5.0R1

nuagenetworks · May 25, 2017 · 7fcde8e · 7fcde8e
1 parent a9cea73
commit 7fcde8e
Show file tree

Hide file tree

Showing 1,852 changed files with 288,307 additions and 238,854 deletions.
diff --git a/LICENSE b/LICENSE
diff --git a/README.md b/README.md
diff --git a/VSPK.pdf b/VSPK.pdf
diff --git a/html/_sources/index.rst.txt → _sources/index.rst.txt b/html/_sources/index.rst.txt → _sources/index.rst.txt
@@ -8,16 +8,17 @@ VSPK Documentation
 
 
 .. toctree::
-    :caption: v4_0 reference
+    :caption: v5_0 reference
     :maxdepth: 1
     :glob:
 
-    v4_0/*
+    v5_0/*
+
 
 .. toctree::
-    :caption: v3_2 reference
+    :caption: v4_0 reference
     :maxdepth: 1
     :glob:
 
-    v3_2/*
+    v4_0/*
 
diff --git a/html/_sources/quickstart.rst.txt → _sources/quickstart.rst.txt b/html/_sources/quickstart.rst.txt → _sources/quickstart.rst.txt
diff --git a/html/_sources/v4_0/nuaddressmap.rst.txt → _sources/v4_0/nuaddressmap.rst.txt b/html/_sources/v4_0/nuaddressmap.rst.txt → _sources/v4_0/nuaddressmap.rst.txt
diff --git a/html/_sources/v4_0/nuaddressrange.rst.txt → _sources/v4_0/nuaddressrange.rst.txt b/html/_sources/v4_0/nuaddressrange.rst.txt → _sources/v4_0/nuaddressrange.rst.txt
diff --git a/..._sources/v3_2/nuaggregatemetadata.rst.txt → _sources/v4_0/nuaggregatemetadata.rst.txt b/..._sources/v3_2/nuaggregatemetadata.rst.txt → _sources/v4_0/nuaggregatemetadata.rst.txt
diff --git a/_sources/v4_0/nualarm.rst.txt b/_sources/v4_0/nualarm.rst.txt
@@ -0,0 +1,95 @@
+.. _nualarm:
+
+nualarm
+===========================================
+
+.. class:: nualarm.NUAlarm(bambou.nurest_object.NUMetaRESTObject,):
+
+The alarm API allows the management of system alarms.
+
+
+Attributes
+----------
+
+
+- ``name`` (**Mandatory**): The alarm name.  Each type of alarm will generate its own name
+
+- ``target_object``: Identifies affected Entity.  Example: Alarm generated by TCA for Domain domain1(Packets towards a VM, Breach)
+
+- ``last_updated_by``: ID of the user who last updated the object.
+
+- ``acknowledged``: Flag to indicate that alarm is already acknowledged or not
+
+- ``reason``: Provides a description of the alarm
+
+- ``description``: Description of the alarm
+
+- ``severity``: Severity of the alarm.
+
+- ``timestamp``: Indicates the time that the alarm was triggered
+
+- ``enterprise_id``: Enterprise that this alarm belongs to
+
+- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level
+
+- ``error_condition``: Identifies the error condition
+
+- ``number_of_occurances``: Number of times that the alarm was triggered
+
+- ``external_id``: External object ID. Used for integration with third party systems
+
+
+
+
+Children
+--------
+
+================================================================================================================================================               ==========================================================================================
+**class**                                                                                                                                                      **fetcher**
+
+:ref:`numetadata.NUMetadata<numetadata>`                                                                                                                         ``metadatas`` 
+:ref:`nuglobalmetadata.NUGlobalMetadata<nuglobalmetadata>`                                                                                                       ``global_metadatas`` 
+================================================================================================================================================               ==========================================================================================
+
+
+
+Parents
+--------
+
+
+- :ref:`nuredundancygroup.NURedundancyGroup<nuredundancygroup>`
+
+- :ref:`nutca.NUTCA<nutca>`
+
+- :ref:`nuvsgredundantport.NUVsgRedundantPort<nuvsgredundantport>`
+
+- :ref:`nuvsc.NUVSC<nuvsc>`
+
+- :ref:`nuvsd.NUVSD<nuvsd>`
+
+- :ref:`nuvport.NUVPort<nuvport>`
+
+- :ref:`nuport.NUPort<nuport>`
+
+- :ref:`nucontainer.NUContainer<nucontainer>`
+
+- :ref:`nuvrs.NUVRS<nuvrs>`
+
+- :ref:`nuhsc.NUHSC<nuhsc>`
+
+- :ref:`nuvlan.NUVLAN<nuvlan>`
+
+- :ref:`nugateway.NUGateway<nugateway>`
+
+- :ref:`nuwanservice.NUWANService<nuwanservice>`
+
+- :ref:`nunsgateway.NUNSGateway<nunsgateway>`
+
+- :ref:`nunsport.NUNSPort<nunsport>`
+
+- :ref:`nuvm.NUVM<nuvm>`
+
+- :ref:`nunsredundantgatewaygroup.NUNSRedundantGatewayGroup<nunsredundantgatewaygroup>`
+
+- :ref:`nuenterprise.NUEnterprise<nuenterprise>`
+
diff --git a/html/_sources/v4_0/nuallalarm.rst.txt → _sources/v4_0/nuallalarm.rst.txt b/html/_sources/v4_0/nuallalarm.rst.txt → _sources/v4_0/nuallalarm.rst.txt
diff --git a/html/_sources/v4_0/nuapplication.rst.txt → _sources/v4_0/nuapplication.rst.txt b/html/_sources/v4_0/nuapplication.rst.txt → _sources/v4_0/nuapplication.rst.txt
diff --git a/...sources/v4_0/nuapplicationbinding.rst.txt → _sources/v4_0/nuapplicationbinding.rst.txt b/...sources/v4_0/nuapplicationbinding.rst.txt → _sources/v4_0/nuapplicationbinding.rst.txt
diff --git a/...uapplicationperformancemanagement.rst.txt → ...uapplicationperformancemanagement.rst.txt b/...uapplicationperformancemanagement.rst.txt → ...uapplicationperformancemanagement.rst.txt
diff --git a/...ationperformancemanagementbinding.rst.txt → ...ationperformancemanagementbinding.rst.txt b/...ationperformancemanagementbinding.rst.txt → ...ationperformancemanagementbinding.rst.txt
diff --git a/...sources/v4_0/nuapplicationservice.rst.txt → _sources/v4_0/nuapplicationservice.rst.txt b/...sources/v4_0/nuapplicationservice.rst.txt → _sources/v4_0/nuapplicationservice.rst.txt
diff --git a/...ources/v4_0/nuautodiscovercluster.rst.txt → _sources/v4_0/nuautodiscovercluster.rst.txt b/...ources/v4_0/nuautodiscovercluster.rst.txt → _sources/v4_0/nuautodiscovercluster.rst.txt
diff --git a/...s/v4_0/nuautodiscovereddatacenter.rst.txt → ...s/v4_0/nuautodiscovereddatacenter.rst.txt b/...s/v4_0/nuautodiscovereddatacenter.rst.txt → ...s/v4_0/nuautodiscovereddatacenter.rst.txt
diff --git a/...rces/v4_0/nuautodiscoveredgateway.rst.txt → ...rces/v4_0/nuautodiscoveredgateway.rst.txt b/...rces/v4_0/nuautodiscoveredgateway.rst.txt → ...rces/v4_0/nuautodiscoveredgateway.rst.txt
diff --git a/_sources/v4_0/nuautodiscoverhypervisorfromcluster.rst.txt b/_sources/v4_0/nuautodiscoverhypervisorfromcluster.rst.txt
@@ -0,0 +1,39 @@
+.. _nuautodiscoverhypervisorfromcluster:
+
+nuautodiscoverhypervisorfromcluster
+===========================================
+
+.. class:: nuautodiscoverhypervisorfromcluster.NUAutoDiscoverHypervisorFromCluster(bambou.nurest_object.NUMetaRESTObject,):
+
+None
+
+
+Attributes
+----------
+
+
+- ``last_updated_by``: ID of the user who last updated the object.
+
+- ``network_list``: The available network list
+
+- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level
+
+- ``assoc_entity_id``: The ID of the cluster to which this host is attached
+
+- ``external_id``: External object ID. Used for integration with third party systems
+
+- ``hypervisor_ip``: IP Address of the Hypervisor
+
+
+
+
+
+
+Parents
+--------
+
+
+- :ref:`nuvcentercluster.NUVCenterCluster<nuvcentercluster>`
+
+- :ref:`nuvcenterdatacenter.NUVCenterDataCenter<nuvcenterdatacenter>`
+
diff --git a/_sources/v4_0/nuavatar.rst.txt b/_sources/v4_0/nuavatar.rst.txt
@@ -0,0 +1,45 @@
+.. _nuavatar:
+
+nuavatar
+===========================================
+
+.. class:: nuavatar.NUAvatar(bambou.nurest_object.NUMetaRESTObject,):
+
+Avatar
+
+
+Attributes
+----------
+
+
+- ``last_updated_by``: ID of the user who last updated the object.
+
+- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level
+
+- ``external_id``: External object ID. Used for integration with third party systems
+
+- ``type``: The image type
+
+
+
+
+Children
+--------
+
+================================================================================================================================================               ==========================================================================================
+**class**                                                                                                                                                      **fetcher**
+
+:ref:`numetadata.NUMetadata<numetadata>`                                                                                                                         ``metadatas`` 
+:ref:`nuglobalmetadata.NUGlobalMetadata<nuglobalmetadata>`                                                                                                       ``global_metadatas`` 
+================================================================================================================================================               ==========================================================================================
+
+
+
+Parents
+--------
+
+
+- :ref:`nuuser.NUUser<nuuser>`
+
+- :ref:`nuenterprise.NUEnterprise<nuenterprise>`
+
diff --git a/html/_sources/v4_0/nubgpneighbor.rst.txt → _sources/v4_0/nubgpneighbor.rst.txt b/html/_sources/v4_0/nubgpneighbor.rst.txt → _sources/v4_0/nubgpneighbor.rst.txt
diff --git a/html/_sources/v4_0/nubgppeer.rst.txt → _sources/v4_0/nubgppeer.rst.txt b/html/_sources/v4_0/nubgppeer.rst.txt → _sources/v4_0/nubgppeer.rst.txt
diff --git a/html/_sources/v4_0/nubgpprofile.rst.txt → _sources/v4_0/nubgpprofile.rst.txt b/html/_sources/v4_0/nubgpprofile.rst.txt → _sources/v4_0/nubgpprofile.rst.txt
diff --git a/html/_sources/v4_0/nubootstrap.rst.txt → _sources/v4_0/nubootstrap.rst.txt b/html/_sources/v4_0/nubootstrap.rst.txt → _sources/v4_0/nubootstrap.rst.txt
diff --git a/...ources/v4_0/nubootstrapactivation.rst.txt → _sources/v4_0/nubootstrapactivation.rst.txt b/...ources/v4_0/nubootstrapactivation.rst.txt → _sources/v4_0/nubootstrapactivation.rst.txt
diff --git a/html/_sources/v4_0/nubrconnection.rst.txt → _sources/v4_0/nubrconnection.rst.txt b/html/_sources/v4_0/nubrconnection.rst.txt → _sources/v4_0/nubrconnection.rst.txt
diff --git a/html/_sources/v3_2/nubridgeinterface.rst.txt → _sources/v4_0/nubridgeinterface.rst.txt b/html/_sources/v3_2/nubridgeinterface.rst.txt → _sources/v4_0/nubridgeinterface.rst.txt
diff --git a/html/_sources/v4_0/nubulkstatistics.rst.txt → _sources/v4_0/nubulkstatistics.rst.txt b/html/_sources/v4_0/nubulkstatistics.rst.txt → _sources/v4_0/nubulkstatistics.rst.txt
diff --git a/html/_sources/v3_2/nucertificate.rst.txt → _sources/v4_0/nucertificate.rst.txt b/html/_sources/v3_2/nucertificate.rst.txt → _sources/v4_0/nucertificate.rst.txt
diff --git a/html/_sources/v3_2/nucloudmgmtsystem.rst.txt → _sources/v4_0/nucloudmgmtsystem.rst.txt b/html/_sources/v3_2/nucloudmgmtsystem.rst.txt → _sources/v4_0/nucloudmgmtsystem.rst.txt
diff --git a/...sources/v4_0/nuconnectionendpoint.rst.txt → _sources/v4_0/nuconnectionendpoint.rst.txt b/...sources/v4_0/nuconnectionendpoint.rst.txt → _sources/v4_0/nuconnectionendpoint.rst.txt
diff --git a/_sources/v4_0/nucontainer.rst.txt b/_sources/v4_0/nucontainer.rst.txt
@@ -0,0 +1,114 @@
+.. _nucontainer:
+
+nucontainer
+===========================================
+
+.. class:: nucontainer.NUContainer(bambou.nurest_object.NUMetaRESTObject,):
+
+Read only API that can retrieve the containers associated with a domain, zone or subnet for mediation created containers for REST created  containers you need to set the additional proxy user header in http request : X-Nuage-ProxyUservalue of the header has to be either :1) enterpriseName@UserName (example : Alcatel Lucent@bob), or 2) external ID of user in VSD, typically is UUID generally decided by the CMS tool in questionUser needs to have CMS privileges to use proxy user header.
+
+
+Attributes
+----------
+
+
+- ``l2_domain_ids``: Array of IDs of the l2 domain that the container is connected to
+
+- ``vrsid``: Id of the VRS that this container is attached to.
+
+- ``uuid`` (**Mandatory**): UUID of the container
+
+- ``name`` (**Mandatory**): Name of the container
+
+- ``last_updated_by``: ID of the user who last updated the object.
+
+- ``reason_type``: Reason of the event associated with the container.
+
+- ``delete_expiry``: reflects the  container Deletion expiry timer in secs , deleteMode needs to be non-null value for deleteExpiry to be taken in to effect. CMS created containers will always have deleteMode set to TIMER
+
+- ``delete_mode``: reflects the mode of container Deletion -  TIMER  Possible values are TIMER, .
+
+- ``resync_info``: Information of the status of the resync operation of a container
+
+- ``site_identifier``: This property specifies the site the container belongs to, for Geo-redundancy.
+
+- ``image_id``: Id of the container image
+
+- ``image_name``: Name of the container image
+
+- ``interfaces``: List of container interfaces associated with the container
+
+- ``enterprise_id``: ID of the enterprise that this container belongs to
+
+- ``enterprise_name``: Name of the enterprise that this container belongs to
+
+- ``entity_scope``: Specify if scope of entity is Data center or Enterprise level
+
+- ``domain_ids``: Array of IDs of the domain that the container is connected to
+
+- ``zone_ids``: Array of IDs of the zone that this container is attached to
+
+- ``orchestration_id`` (**Mandatory**): Orchestration ID
+
+- ``user_id``: ID of the user that created this container
+
+- ``user_name``: Username of the user that created this container
+
+- ``status``: Status of the container.
+
+- ``subnet_ids``: Array of IDs of the subnets that the container is connected to
+
+- ``external_id``: External object ID. Used for integration with third party systems
+
+- ``hypervisor_ip``: IP address of the hypervisor that this container is currently running in
+
+
+
+
+Children
+--------
+
+================================================================================================================================================               ==========================================================================================
+**class**                                                                                                                                                      **fetcher**
+
+:ref:`numetadata.NUMetadata<numetadata>`                                                                                                                         ``metadatas`` 
+:ref:`nualarm.NUAlarm<nualarm>`                                                                                                                                  ``alarms`` 
+:ref:`nuglobalmetadata.NUGlobalMetadata<nuglobalmetadata>`                                                                                                       ``global_metadatas`` 
+:ref:`nucontainerinterface.NUContainerInterface<nucontainerinterface>`                                                                                           ``container_interfaces`` 
+:ref:`nucontainerresync.NUContainerResync<nucontainerresync>`                                                                                                    ``container_resyncs`` 
+:ref:`nuvrs.NUVRS<nuvrs>`                                                                                                                                        ``vrss`` 
+:ref:`nueventlog.NUEventLog<nueventlog>`                                                                                                                         ``event_logs`` 
+================================================================================================================================================               ==========================================================================================
+
+
+
+Parents
+--------
+
+
+- :ref:`nuqos.NUQOS<nuqos>`
+
+- :ref:`nuzone.NUZone<nuzone>`
+
+- :ref:`nuvport.NUVPort<nuvport>`
+
+- :ref:`nusubnet.NUSubnet<nusubnet>`
+
+- :ref:`nuvrs.NUVRS<nuvrs>`
+
+- :ref:`nudomain.NUDomain<nudomain>`
+
+- :ref:`nul2domain.NUL2Domain<nul2domain>`
+
+- :ref:`nume.NUMe<nume>`
+
+- :ref:`nuegressacltemplate.NUEgressACLTemplate<nuegressacltemplate>`
+
+- :ref:`nuuser.NUUser<nuuser>`
+
+- :ref:`nutier.NUTier<nutier>`
+
+- :ref:`nuenterprise.NUEnterprise<nuenterprise>`
+
+- :ref:`nuingressacltemplate.NUIngressACLTemplate<nuingressacltemplate>`
+
diff --git a/...sources/v4_0/nucontainerinterface.rst.txt → _sources/v4_0/nucontainerinterface.rst.txt b/...sources/v4_0/nucontainerinterface.rst.txt → _sources/v4_0/nucontainerinterface.rst.txt
diff --git a/html/_sources/v4_0/nucontainerresync.rst.txt → _sources/v4_0/nucontainerresync.rst.txt b/html/_sources/v4_0/nucontainerresync.rst.txt → _sources/v4_0/nucontainerresync.rst.txt
diff --git a/html/_sources/v4_0/nucustomproperty.rst.txt → _sources/v4_0/nucustomproperty.rst.txt b/html/_sources/v4_0/nucustomproperty.rst.txt → _sources/v4_0/nucustomproperty.rst.txt
diff --git a/...sources/v4_0/nudemarcationservice.rst.txt → _sources/v4_0/nudemarcationservice.rst.txt b/...sources/v4_0/nudemarcationservice.rst.txt → _sources/v4_0/nudemarcationservice.rst.txt
diff --git a/html/_sources/v4_0/nudhcpoption.rst.txt → _sources/v4_0/nudhcpoption.rst.txt b/html/_sources/v4_0/nudhcpoption.rst.txt → _sources/v4_0/nudhcpoption.rst.txt
diff --git a/html/_sources/v3_2/nudiskstat.rst.txt → _sources/v4_0/nudiskstat.rst.txt b/html/_sources/v3_2/nudiskstat.rst.txt → _sources/v4_0/nudiskstat.rst.txt
diff --git a/html/_sources/v4_0/nudomain.rst.txt → _sources/v4_0/nudomain.rst.txt b/html/_sources/v4_0/nudomain.rst.txt → _sources/v4_0/nudomain.rst.txt
diff --git a/...urces/v4_0/nudomainfipacltemplate.rst.txt → _sources/v4_0/nudomainfipacltemplate.rst.txt b/...urces/v4_0/nudomainfipacltemplate.rst.txt → _sources/v4_0/nudomainfipacltemplate.rst.txt
diff --git a/.../v4_0/nudomainfipacltemplateentry.rst.txt → .../v4_0/nudomainfipacltemplateentry.rst.txt b/.../v4_0/nudomainfipacltemplateentry.rst.txt → .../v4_0/nudomainfipacltemplateentry.rst.txt
diff --git a/html/_sources/v4_0/nudomaintemplate.rst.txt → _sources/v4_0/nudomaintemplate.rst.txt b/html/_sources/v4_0/nudomaintemplate.rst.txt → _sources/v4_0/nudomaintemplate.rst.txt
diff --git a/...v3_2/nudscpforwardingclassmapping.rst.txt → ...v4_0/nudscpforwardingclassmapping.rst.txt b/...v3_2/nudscpforwardingclassmapping.rst.txt → ...v4_0/nudscpforwardingclassmapping.rst.txt
diff --git a/...s/v3_2/nudscpforwardingclasstable.rst.txt → ...s/v4_0/nudscpforwardingclasstable.rst.txt b/...s/v3_2/nudscpforwardingclasstable.rst.txt → ...s/v4_0/nudscpforwardingclasstable.rst.txt
diff --git a/html/_sources/v4_0/nuducgroup.rst.txt → _sources/v4_0/nuducgroup.rst.txt b/html/_sources/v4_0/nuducgroup.rst.txt → _sources/v4_0/nuducgroup.rst.txt
diff --git a/html/_sources/v4_0/nuducgroupbinding.rst.txt → _sources/v4_0/nuducgroupbinding.rst.txt b/html/_sources/v4_0/nuducgroupbinding.rst.txt → _sources/v4_0/nuducgroupbinding.rst.txt
diff --git a/...ces/v4_0/nuegressaclentrytemplate.rst.txt → ...ces/v4_0/nuegressaclentrytemplate.rst.txt b/...ces/v4_0/nuegressaclentrytemplate.rst.txt → ...ces/v4_0/nuegressaclentrytemplate.rst.txt
diff --git a/..._sources/v4_0/nuegressacltemplate.rst.txt → _sources/v4_0/nuegressacltemplate.rst.txt b/..._sources/v4_0/nuegressacltemplate.rst.txt → _sources/v4_0/nuegressacltemplate.rst.txt
diff --git a/html/_sources/v3_2/nuegressqospolicy.rst.txt → _sources/v4_0/nuegressqospolicy.rst.txt b/html/_sources/v3_2/nuegressqospolicy.rst.txt → _sources/v4_0/nuegressqospolicy.rst.txt
diff --git a/html/_sources/v3_2/nuendpoint.rst.txt → _sources/v4_0/nuendpoint.rst.txt b/html/_sources/v3_2/nuendpoint.rst.txt → _sources/v4_0/nuendpoint.rst.txt