From 2491c53654cdbbed4abe776a5822200a0eeebcaa Mon Sep 17 00:00:00 2001 From: Anusha Hegde Date: Fri, 6 Sep 2019 13:55:12 +0530 Subject: [PATCH] updating draas docs with latest Task and Replication APIs --- vmc-draas/_sources/index.rst.txt | 2 +- vmc-draas/com.vmware.vmc.draas.html | 63 ++++++++++++++++- vmc-draas/com.vmware.vmc.html | 101 ++++++++++++++++++++++++++++ vmc-draas/genindex.html | 29 +++++++- vmc-draas/objects.inv | Bin 958 -> 995 bytes vmc-draas/searchindex.js | 2 +- 6 files changed, 190 insertions(+), 7 deletions(-) diff --git a/vmc-draas/_sources/index.rst.txt b/vmc-draas/_sources/index.rst.txt index 1d8f1404..5d846af9 100644 --- a/vmc-draas/_sources/index.rst.txt +++ b/vmc-draas/_sources/index.rst.txt @@ -1,5 +1,5 @@ .. vAPI documentation master file, created by - sphinx-quickstart on Tue Sep 3 15:28:22 2019. + sphinx-quickstart on Fri Sep 6 13:52:42 2019. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. diff --git a/vmc-draas/com.vmware.vmc.draas.html b/vmc-draas/com.vmware.vmc.draas.html index 11a98c7e..95c5b320 100644 --- a/vmc-draas/com.vmware.vmc.draas.html +++ b/vmc-draas/com.vmware.vmc.draas.html @@ -217,7 +217,11 @@ names.

Parameters:srm_extension_key_suffix (str or None) – Optional custom extension key suffix for SRM. If not specified, -default extension key will be used. +default extension key will be used. The custom extension suffix +must contain 13 characters or less, be composed of letters, +numbers, ., -, and _ characters. The extension suffix must begin +and end with a letter or number. The suffix is appended to +com.vmware.vcDr- to form the full extension key. @@ -274,6 +278,60 @@ default extension key will be used. +
+
+class com.vmware.vmc.draas.model_client.ReplicaDisk(space_requirement=None, name=None, collection_id=None, datastores_for_single_host_move=None, movable=None, disk_id=None, datastore_mo_id=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • space_requirement (float or None) –
    • +
  • name (str or None) –
    • +
  • collection_id (str or None) –
    • +
  • datastores_for_single_host_move (list of vmware.vapi.struct.VapiStruct or None) –
    • +
  • movable (bool or None) –
    • +
  • disk_id (str or None) –
    • +
  • datastore_mo_id (str or None) –
    • +
+
+
+ +
+
+class com.vmware.vmc.draas.model_client.ReplicaDiskCollection(collection_id=None, generated=None, disks=None, placeholder_vm_mo_id=None, name=None)
+

Bases: vmware.vapi.bindings.struct.VapiStruct

+
+

Tip

+

The arguments are used to initialize data attributes with the same +names.

+
+ +++ + + + +
Parameters:
    +
  • collection_id (str or None) –
    • +
  • generated (datetime.datetime or None) –
    • +
  • disks (list of ReplicaDisk or None) –
    • +
  • placeholder_vm_mo_id (str or None) –
    • +
  • name (str or None) –
    • +
+
+
+
class com.vmware.vmc.draas.model_client.SiteRecovery(updated=None, user_id=None, created=None, updated_by_user_id=None, version=None, updated_by_user_name=None, user_name=None, id=None, site_recovery_state=None, vr_node=None, srm_nodes=None, sddc_id=None, draas_h5_url=None)
@@ -506,7 +564,7 @@ names.

-class com.vmware.vmc.draas.model_client.SiteRecoveryVersions(sddc_id=None, node_versions=None)
+class com.vmware.vmc.draas.model_client.SiteRecoveryVersions(generated=None, sddc_id=None, node_versions=None)

Bases: vmware.vapi.bindings.struct.VapiStruct

Tip

@@ -518,6 +576,7 @@ names.

Parameters:
    +
  • generated (datetime.datetime or None) –
  • sddc_id (str or None) –
  • node_versions (list of SiteRecoveryNodeVersion or None) – list of site recovery node version
diff --git a/vmc-draas/com.vmware.vmc.html b/vmc-draas/com.vmware.vmc.html index cca2f0f8..0fca864e 100644 --- a/vmc-draas/com.vmware.vmc.html +++ b/vmc-draas/com.vmware.vmc.html @@ -184,6 +184,57 @@

com.vmware.vmc.draas_client module

+
+
+class com.vmware.vmc.draas_client.ReplicaDiskCollections(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(org, sddc, datastore_mo_id=None)
+

Query replica disk collections

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • org (str) – Organization identifier (required)
    • +
  • sddc (str) – sddc identifier (required)
    • +
  • datastore_mo_id (str or None) – Represents the datastore moref id to search. (optional)
    • +
+
Return type:

list of com.vmware.vmc.draas.model_client.ReplicaDiskCollection

+
Returns:

+
Raise:

com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Not found

+
+
+ +
+
class com.vmware.vmc.draas_client.SiteRecovery(config)
@@ -539,6 +590,56 @@ Cannot find site recovery versions for sddc identifier

+
+
+class com.vmware.vmc.draas_client.Task(config)
+

Bases: vmware.vapi.bindings.stub.VapiInterface

+ +++ + + + +
Parameters:config (vmware.vapi.bindings.stub.StubConfiguration) – Configuration to be used for creating the stub.
+
+
+get(org, task)
+

Retrieve details of a task.

+ +++ + + + + + + + + + + + + + +
Parameters:
    +
  • org (str) – Organization identifier (required)
    • +
  • task (str) – task identifier (required)
    • +
+
Return type:

com.vmware.vmc.draas.model_client.Task

+
Returns:

com.vmware.vmc.draas.model.Task

+
Raise:

com.vmware.vapi.std.errors_client.Unauthenticated +Unauthorized

+
Raise:

com.vmware.vapi.std.errors_client.Unauthorized +Forbidden

+
Raise:

com.vmware.vapi.std.errors_client.NotFound +Cannot find the task with given identifier

+
+
+ +
+ diff --git a/vmc-draas/genindex.html b/vmc-draas/genindex.html index b12df3b0..cf9cb237 100644 --- a/vmc-draas/genindex.html +++ b/vmc-draas/genindex.html @@ -160,6 +160,7 @@ | G | N | P + | R | S | T | V @@ -224,16 +225,20 @@

G

+

R

+ + + +
+

S

    @@ -349,7 +368,11 @@ diff --git a/vmc-draas/objects.inv b/vmc-draas/objects.inv index c3634b5881c2f6b8a6dddb6835df9911e67e34b9..bff04baed6ae1ea72901d782a210499499fcaadd 100644 GIT binary patch delta 858 zcmV-g1Eu`F2jd5jmVe8VqA(PO_x%)^n%PQqZ+k}}-9wcZ3T&rbQ86BsY9Le+opv{` zF|RjIGKnaSf{Hf5m6+uGUy_rPE1@w;H_tJhts+2=h|t(ria7e7rF4Fv&Vx!@$Gtbw1xsVbFy`m%w*_jc7&0HCfJ7lALW87XPJg*zmvIEbyhGW~C1pdgBe@$!TjO9mHQLzv#oUR14NOlIV zt)ne-VA;Jpw12s4-><)O_C0#ME4%w1jeap5&3+!p3|$ecw2k(LYyr3Rm*#$d|Mdwstxl6KG-7}vOiC?Jf%uxkfx zxvC6p!);a6)}V5+QL!EP!#B^egWkQsW3%sAJx3>fM}Ovx4qLIBzQ}VDZFb)~!p$B4 zl-_o7ee<;~#bt(u1+fUxvkD#%oPp#2)XR`R-bfEZo>dnNICq!$tB2qkR}FP88O|O^ z&jn_k%AHU(7Le5&#FEZ#l&*Qey;{qVE&~CL*01pf8!6=)6obb`HGLMV^@TU-p1r0H zH|5%m_kV7Uh3;leUG{dTMP8YDrz#3e?u9-L8t;@e?=WduyDA zRmD~MIh)dT`cd8`Tccu4x=q3u$HdCT_B~yxbzbCz->+3746uMerWDrQ`6|ioZLiVe zX)q5X0qkqNl*<^F@A^PiEEMY2UciTV$@Q;q?tf)nHEe?ze*_F9!170;$rqZqXc!H^2aUpfl^G~@dApkTSr9;A&iP|U?szCR8|}B ztAmc8#41I0?_H;*KDV8y`lW0qyMQE2X7I6z>F*pEwZ$%u%G3-sv%|1 k6uolfk>cc9w#esJbTA2*ZI9hqHM~%1Qr_wO2Sdw%EdZ6LQvd(} delta 821 zcmV-51Iqm42fhc8mVe!HqA(Q4@B0+l*}au%Z+pie?K0yB1J)g{m>5o#DG(=#ZoS*r z*w@=9*+h_{pkhn#N=$P8Ka!J^LlQz0wAwx5+@fi#GLrz)AstcAz$S~&T>~{?ssTi^z;(){vq(XzFVSmoKV3-Iy6_MB~0*Nu_ z=-~{Yp)wKC1`F^b0Ui*#0k*Yh`Wh|Tq}Ys6<^f;PltY`sE~A@>M>O?W(*A3g2St~z z;X4yM@N8>5wY^#3PfYpOv?k6}KJ*n83&EoKT0nF$J-9)i`}Xa|yI|j9 z#QSo%Z_()|(|^(I=aH9a&F*St;l>@{_`snBkHbQ|Q2Piq>__9VDA2e(RVmUuspY$bXc zW!XZi=6{^@#2M+{8n2?d=BoUhP32(qsP2-jQM0OkPQsWb#45!015~SZUgX43U#mnI zU;%+FDP@k=bxMTVH(aB~SHWu(3t(Rxr9#HAeAfrEW|2_mw*ub9Q=xx-cQ5Oz2nZ7V z9x#yMl`W`6G_(%lc}+mFDt$D*r0Y1`^=jLUB7fr*aS=X-l%U>2am}F~&@O9~)C(Z+P0e}DdRBwMW$8D3b$)weqt0X3l2wzsdyl!jRtWk?Q~ zkuK$-MOKzI_Op6db)@Q