vsphere-automation-sdk-python/nsx/nsx_vmc_aws_integration/searchindex.js

Search.setIndex({docnames:["com","com.vmware","com.vmware.nsx_vmc_app","com.vmware.nsx_vmc_app.infra","com.vmware.nsx_vmc_app.infra.direct_connect","com.vmware.nsx_vmc_app.infra.external","enumeration","index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":2,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["com.rst","com.vmware.rst","com.vmware.nsx_vmc_app.rst","com.vmware.nsx_vmc_app.infra.rst","com.vmware.nsx_vmc_app.infra.direct_connect.rst","com.vmware.nsx_vmc_app.infra.external.rst","enumeration.rst","index.rst"],objects:{"":{com:[0,0,0,"-"]},"com.vmware":{nsx_vmc_app:[2,0,0,"-"],nsx_vmc_app_client:[1,0,0,"-"]},"com.vmware.nsx_vmc_app":{infra:[3,0,0,"-"],infra_client:[2,0,0,"-"],model_client:[2,0,0,"-"]},"com.vmware.nsx_vmc_app.infra":{direct_connect:[4,0,0,"-"],direct_connect_client:[3,0,0,"-"],external:[5,0,0,"-"],external_client:[3,0,0,"-"],linked_vpcs_client:[3,0,0,"-"],realized_state_client:[3,0,0,"-"]},"com.vmware.nsx_vmc_app.infra.direct_connect":{routes_client:[4,0,0,"-"]},"com.vmware.nsx_vmc_app.infra.direct_connect.routes_client":{Advertised:[4,1,1,""],Learned:[4,1,1,""],StubFactory:[4,1,1,""]},"com.vmware.nsx_vmc_app.infra.direct_connect.routes_client.Advertised":{get:[4,2,1,""]},"com.vmware.nsx_vmc_app.infra.direct_connect.routes_client.Learned":{get:[4,2,1,""]},"com.vmware.nsx_vmc_app.infra.direct_connect_client":{Bgp:[3,1,1,""],StubFactory:[3,1,1,""],Vifs:[3,1,1,""]},"com.vmware.nsx_vmc_app.infra.direct_connect_client.Bgp":{get:[3,2,1,""],patch:[3,2,1,""],update:[3,2,1,""]},"com.vmware.nsx_vmc_app.infra.direct_connect_client.Vifs":{"delete":[3,2,1,""],CREATE_ACTION_ATTACH:[3,3,1,""],create:[3,2,1,""],list:[3,2,1,""]},"com.vmware.nsx_vmc_app.infra.external":{routes_client:[5,0,0,"-"]},"com.vmware.nsx_vmc_app.infra.external.routes_client":{Advertised:[5,1,1,""],Learned:[5,1,1,""],StubFactory:[5,1,1,""]},"com.vmware.nsx_vmc_app.infra.external.routes_client.Advertised":{LIST_CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP:[5,3,1,""],LIST_CONNECTIVITY_TYPE_DIRECT_CONNECT:[5,3,1,""],list:[5,2,1,""]},"com.vmware.nsx_vmc_app.infra.external.routes_client.Learned":{LIST_CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP:[5,3,1,""],LIST_CONNECTIVITY_TYPE_DIRECT_CONNECT:[5,3,1,""],list:[5,2,1,""]},"com.vmware.nsx_vmc_app.infra.external_client":{Config:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.nsx_vmc_app.infra.external_client.Config":{get:[3,2,1,""],update:[3,2,1,""]},"com.vmware.nsx_vmc_app.infra.linked_vpcs_client":{ConnectedServices:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.nsx_vmc_app.infra.linked_vpcs_client.ConnectedServices":{list:[3,2,1,""],update:[3,2,1,""]},"com.vmware.nsx_vmc_app.infra.realized_state_client":{Status:[3,1,1,""],StubFactory:[3,1,1,""]},"com.vmware.nsx_vmc_app.infra.realized_state_client.Status":{get:[3,2,1,""]},"com.vmware.nsx_vmc_app.infra_client":{Accounts:[2,1,1,""],AssociatedGroups:[2,1,1,""],FeatureFlags:[2,1,1,""],LinkedVpcs:[2,1,1,""],MgmtVms:[2,1,1,""],PublicIps:[2,1,1,""],SddcUserConfig:[2,1,1,""],StubFactory:[2,1,1,""]},"com.vmware.nsx_vmc_app.infra_client.Accounts":{get:[2,2,1,""]},"com.vmware.nsx_vmc_app.infra_client.AssociatedGroups":{"delete":[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx_vmc_app.infra_client.FeatureFlags":{get:[2,2,1,""]},"com.vmware.nsx_vmc_app.infra_client.LinkedVpcs":{get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx_vmc_app.infra_client.MgmtVms":{get:[2,2,1,""],list:[2,2,1,""]},"com.vmware.nsx_vmc_app.infra_client.PublicIps":{"delete":[2,2,1,""],get:[2,2,1,""],list:[2,2,1,""],update:[2,2,1,""]},"com.vmware.nsx_vmc_app.infra_client.SddcUserConfig":{get:[2,2,1,""]},"com.vmware.nsx_vmc_app.model_client":{AdvertisedRoute:[2,1,1,""],ApiError:[2,1,1,""],AssociatedBaseGroupConnectionInfo:[2,1,1,""],AssociatedGroupConnectionInfosListResult:[2,1,1,""],AssociatedTgwGroupConnectionInfo:[2,1,1,""],BGPAdvertisedRoutes:[2,1,1,""],BGPLearnedRoutes:[2,1,1,""],ConnectedServiceListResult:[2,1,1,""],ConnectedServiceStatus:[2,1,1,""],CsvListResult:[2,1,1,""],CsvRecord:[2,1,1,""],DirectConnectBgpInfo:[2,1,1,""],DirectConnectConfig:[2,1,1,""],ExternalSddcConnectivity:[2,1,1,""],ExternalSddcRoute:[2,1,1,""],ExternalSddcRouteCsvRecord:[2,1,1,""],ExternalSddcRoutesListResult:[2,1,1,""],ExternalSddcRoutesListResultInCsvFormat:[2,1,1,""],IncludedFieldsParameters:[2,1,1,""],IpAttachmentPair:[2,1,1,""],LinkedSubnetInfo:[2,1,1,""],LinkedVpcInfo:[2,1,1,""],LinkedVpcsListResult:[2,1,1,""],ListResult:[2,1,1,""],MgmtServiceEntry:[2,1,1,""],MgmtVmInfo:[2,1,1,""],MgmtVmsListResult:[2,1,1,""],ModelInterface:[2,1,1,""],PublicIp:[2,1,1,""],PublicIpsListResult:[2,1,1,""],RelatedApiError:[2,1,1,""],Resource:[2,1,1,""],ResourceLink:[2,1,1,""],SddcUserConfiguration:[2,1,1,""],SelfResourceLink:[2,1,1,""],StubFactory:[2,1,1,""],VMCAccounts:[2,1,1,""],VifsListResult:[2,1,1,""],VirtualInterface:[2,1,1,""],VmcConsolidatedRealizedStatus:[2,1,1,""],VmcConsolidatedStatus:[2,1,1,""],VmcConsolidatedStatusPerObject:[2,1,1,""],VmcFeatureFlagInfo:[2,1,1,""],VmcFeatureFlags:[2,1,1,""],VmcKeyValueProviderGatewayListPair:[2,1,1,""],VmcProviderGateway:[2,1,1,""],VpnEndpoint:[2,1,1,""]},"com.vmware.nsx_vmc_app.model_client.AdvertisedRoute":{ADVERTISEMENT_STATE_FAILED:[2,3,1,""],ADVERTISEMENT_STATE_SUCCESS:[2,3,1,""]},"com.vmware.nsx_vmc_app.model_client.AssociatedBaseGroupConnectionInfo":{RESOURCE_TYPE_ASSOCIATEDTGWGROUPCONNECTIONINFO:[2,3,1,""],resource_type:[2,2,1,""]},"com.vmware.nsx_vmc_app.model_client.AssociatedTgwGroupConnectionInfo":{STATE_CONNECTED:[2,3,1,""],STATE_DISCONNECTED:[2,3,1,""],resource_type:[2,2,1,""]},"com.vmware.nsx_vmc_app.model_client.DirectConnectBgpInfo":{ROUTE_PREFERENCE_DIRECT_CONNECT_PREFERRED_OVER_VPN:[2,3,1,""],ROUTE_PREFERENCE_VPN_PREFERRED_OVER_DIRECT_CONNECT:[2,3,1,""]},"com.vmware.nsx_vmc_app.model_client.ExternalSddcConnectivity":{CONNECTIVITY_TYPE_DEPLOYMENT_CONNECTIVITY_GROUP:[2,3,1,""],CONNECTIVITY_TYPE_DIRECT_CONNECT:[2,3,1,""],ROUTE_TYPE_PROPAGATED:[2,3,1,""],ROUTE_TYPE_STATIC:[2,3,1,""],STATUS_FAILED:[2,3,1,""],STATUS_SUCCEEDED:[2,3,1,""]},"com.vmware.nsx_vmc_app.model_client.VirtualInterface":{BGP_STATUS_DOWN:[2,3,1,""],BGP_STATUS_UP:[2,3,1,""],STATE_ATTACHED:[2,3,1,""],STATE_ATTACHING:[2,3,1,""],STATE_AVAILABLE:[2,3,1,""],STATE_CONFIRMING:[2,3,1,""],STATE_DELETED:[2,3,1,""],STATE_DELETING:[2,3,1,""],STATE_DOWN:[2,3,1,""],STATE_ERROR:[2,3,1,""],STATE_PENDING:[2,3,1,""],STATE_REJECTED:[2,3,1,""],STATE_VERIFYING:[2,3,1,""]},"com.vmware.nsx_vmc_app.model_client.VmcConsolidatedStatus":{CONSOLIDATED_STATUS_ERROR:[2,3,1,""],CONSOLIDATED_STATUS_IN_PROGRESS:[2,3,1,""],CONSOLIDATED_STATUS_SUCCESS:[2,3,1,""],CONSOLIDATED_STATUS_UNAVAILABLE:[2,3,1,""]},"com.vmware.nsx_vmc_app.model_client.VmcFeatureFlagInfo":{STATE_DISABLED:[2,3,1,""],STATE_ENABLED:[2,3,1,""],STATE_INACTIVE:[2,3,1,""]},"com.vmware.nsx_vmc_app_client":{StubFactory:[1,1,1,""]},com:{vmware:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute"},terms:{"abstract":2,"class":[1,2,3,4,5,6],"default":[2,5],"enum":6,"import":6,"long":[2,5],"new":[2,6],"public":2,"return":[2,3,4,5],"static":2,"throw":3,"true":2,"try":3,"while":3,AWS:2,For:[2,3],IPs:2,Not:[2,3,4,5],The:[2,3,6],VMs:2,about:2,access:2,account:2,across:2,action:[2,3],activ:2,active_eni:2,add:2,addit:2,address:2,advertis:[2,4,5],advertised_rout:2,advertisedrout:2,advertisement_st:2,advertisement_state_fail:2,advertisement_state_success:2,after:[2,3],aggreg:2,all:[2,3],all_uplink_interface_label:2,all_vpn_interface_label:2,alloc:2,allow:[2,6],along:3,amazon:2,ani:3,api:[2,3,4,5,6],apierror:2,app:3,appropri:2,argument:2,arn:2,arn_rol:2,ascend:2,asn:[2,3],associ:2,associated_base_group_connection_info:2,associatedbasegroupconnectioninfo:2,associatedgroup:2,associatedgroupconnectioninfoslistresult:2,associatedtgwgroupconnectioninfo:2,attach:[2,3],attachment_id:2,attribut:[2,6],attrit:6,autonom:[2,3],avail:[2,3],availability_zon:2,aval:3,back:6,backend:2,bad:[2,3,4,5],base:[1,2,3,4,5,6],befor:[2,3],being:2,bgp:[2,3,4],bgp_statu:2,bgp_status_down:2,bgp_status_up:2,bgpadvertisedrout:[2,4],bgplearnedrout:[2,4],bind:[1,2,3,4,5,6],block:2,bool:[2,5],both:[2,6],call:3,can:[2,3,6],caught:2,cgw_snat_ip:2,check:3,cidr:2,client:2,code:2,collect:2,com:[6,7],comma:[2,5],commun:6,comput:2,compute_domain:2,compute_gatewai:2,config:[1,2,3,4,5],configur:[2,3,4,5],confirm:[2,3],connect:[2,3,4,5],connected_service_statu:3,connected_vpc_mtu:2,connectedservic:3,connectedservicelistresult:[2,3],connectedservicestatu:[2,3],connectivity_detail:2,connectivity_typ:[2,5],connectivity_type_deployment_connectivity_group:2,connectivity_type_direct_connect:2,connectivitytyp:5,connector:2,consist:3,consolid:[2,3],consolidated_statu:2,consolidated_status_error:2,consolidated_status_in_progress:2,consolidated_status_per_object:2,consolidated_status_success:2,consolidated_status_unavail:2,contain:[2,3,6],content:7,could:2,count:2,creat:[2,3,4,5,6],create_action_attach:3,createspec:6,csv:2,csvlistresult:2,csvrecord:2,current:[2,3,5,6],cursor:[2,5],custom:2,data:2,datacent:[2,4],datail:2,dedic:2,defin:[2,6],definit:2,delet:[2,3],deployment_connectivity_group:[2,5],deprec:2,describ:2,descript:[2,6],destin:2,detach:3,detail:2,direct:[2,3,4],direct_connect:[0,1,2,3,5,7],direct_connect_bgp_info:3,direct_connect_cli:[0,1,2,7],direct_connect_config:3,direct_connect_id:2,direct_connect_preferred_over_vpn:2,directconnect:2,directconnectbgpinfo:[2,3],directconnectconfig:[2,3],disabl:2,disconnect:[2,3],discrimin:2,displai:2,display_nam:2,doe:6,domain:2,down:[2,3],dx_interface_label:2,dynam:2,each:2,edg:2,els:6,enabl:2,endpoint:2,enforc:2,eni:2,entiti:[2,6],entity_metadata:6,entri:2,environ:2,error:[2,3,4,5],error_cod:2,error_data:2,error_messag:2,errors_cli:[2,3,4,5],etc:2,even:2,exampl:3,exist:2,explain:6,extern:[0,1,2,3,7],external_cli:[0,1,2,7],external_id:2,external_route_table_id:2,externalsddcconnect:2,externalsddcrout:2,externalsddcroutecsvrecord:2,externalsddcrouteslistresult:[2,5],externalsddcrouteslistresultincsvformat:2,fail:[2,3,4,5],failed_advertised_rout:2,fals:2,featur:2,featureflag:2,fewer:[2,5],field:[2,5],file:[2,6],file_nam:2,filepath:6,first:[2,6],flag:2,folder:6,follow:[2,6],forbidden:[2,3,4,5],forc:2,format:2,found:[2,3,4,5],from:[2,3,4,6],further:2,futur:[3,6],gatewai:2,gener:6,get:[2,3,4,5,6],given:[2,3],group:[2,3],group_path:2,has:6,have:6,help:2,how:6,href:2,http:2,identifi:2,ignor:2,in_progress:2,inact:2,includ:[2,3,5,6],included_field:[2,5],includedfieldsparamet:2,index:7,indic:3,individu:2,info:2,infom:2,inform:[2,3],infra:[0,1,2,7],infra_cli:[0,1,7],infrom:2,initi:[1,2,3,4,5],instanc:[1,2,3,4,5,6],instanti:6,instead:2,int32:2,int64:2,intent:[2,3],intent_path:[2,3],interfac:[2,3],intern:[2,3,4,5],internal_nam:2,internalservererror:[2,3,4,5],internet:2,internet_mtu:2,intranet_mtu:2,invalidrequest:[2,3,4,5],ip_attachment_pair:2,ipattachmentpair:2,ips:2,ipv4:2,ipv4_cidr:2,its:2,job:2,json:6,just:2,kei:2,kind:2,know:3,label:2,learn:[2,4,5],level:2,link:[2,3],linked_account:2,linked_vpc_account:2,linked_vpc_address:2,linked_vpc_id:[2,3],linked_vpc_interface_label:2,linked_vpc_nat_ip:2,linked_vpc_subnet:2,linked_vpcs_cli:[0,1,2,7],linkedsubnetinfo:2,linkedvpc:2,linkedvpcinfo:2,linkedvpcslistresult:2,list:[2,3,5],list_connectivity_type_deployment_connectivity_group:5,list_connectivity_type_direct_connect:5,listresult:2,live:[2,4,5],local:2,local_as_num:2,local_ip:2,mai:[2,5,6],make:3,manag:2,management_domain:2,management_gatewai:2,management_gateway_label:2,map:2,maximum:[2,5],mean:2,messag:2,metadata:6,metadata_cli:6,method:[2,3,5,6],mgmt_subnet:2,mgmtserviceentri:2,mgmtvm:2,mgmtvminfo:2,mgmtvmslistresult:2,mgw_snat_ip:2,model:[2,3,4,5],model_cli:[0,1,3,4,5,7],modelinterfac:2,modifi:2,modul:[0,6,7],module_nam:2,mtu:2,multipl:3,must:2,name:[2,3,6],nat:2,network:2,newer:6,next:[2,5],non:3,none:[2,5],notfound:[2,3,4,5],nsx_vmc_app:[0,1,7],nsx_vmc_app_client:[0,7],nsx_vmc_app_client_for_vmc:[0,7],number:[2,3,5],numer:2,object:[2,3],object_id:2,obtain:2,occur:2,older:6,omit:2,one:[3,6],onli:[2,6],opaqu:[2,5],oper:[2,3],option:[2,5],order:2,other:[2,3],out:3,outpost:2,over:2,packag:7,page:[2,5,6,7],page_s:[2,5],pair:2,paramet:[1,2,3,4,5,6],particular:2,pass:[2,6],patch:3,path:[2,3],payload:2,pend:[2,3],perform:3,pleas:2,point:[2,3],polici:2,popul:2,port:2,possibl:[2,3,5],post:[2,3],precondit:[2,3,4,5],prefer:[2,3],premis:[2,4],present:2,print:6,privat:2,program:6,progress:[2,3],propag:2,properti:2,provid:[2,3,4,5,6],provider_gatewai:2,provider_nam:2,public_interface_label:2,public_ip:2,public_ip_id:2,publicip:2,publicipslistresult:2,put:2,queri:[2,3,4,5],rais:[2,3,4,5],rang:2,read:2,realiz:2,realizationstatu:3,realized_state_cli:[0,1,2,7],receiv:6,record:[2,5],refer:2,reflect:2,regard:2,reject:[2,3],rel:2,relat:[2,3],related_error:2,relatedapierror:2,releas:2,remot:[2,6],remote_asn:2,remote_ip:2,remov:2,repres:[2,6],request:[2,3,4,5],requir:[2,3],resourc:2,resource_typ:2,resource_type_associatedtgwgroupconnectioninfo:2,resourcelink:2,respons:[2,3,6],result:[2,5],result_count:2,retriev:[2,4,5],retur:2,rfc:2,role:2,rout:[2,3,4,5],route_prefer:2,route_preference_direct_connect_preferred_over_vpn:2,route_preference_vpn_preferred_over_direct_connect:2,route_table_id:2,route_typ:2,route_type_propag:2,route_type_stat:2,router:2,routes_cli:[0,1,2,3,7],rule:2,run:2,same:2,schema:2,sddc:[2,3,5],sddc_group_id:2,sddc_infra_subnet:2,sddcs_route_table_id:2,sddcuserconfig:2,sddcuserconfigur:2,sdddc:5,sdk:6,search:7,see:6,self:2,self_:2,selfresourcelink:2,send:6,separ:[2,5],server:[2,3,4,5,6],servic:[2,3,4,5,6],service_arn_rol:2,service_nam:3,serviceunavail:[2,3,4,5],set:2,shadow:2,shadow_account:2,should:[2,3,5],side:2,sinc:6,skynet:2,snat:2,somewher:2,sort:[2,5],sort_ascend:[2,5],sort_bi:[2,5],sourc:[2,6],source_info:6,source_svc:6,sourcetyp:6,spec:6,special:6,specif:3,specifi:[3,6],state:[2,3],state_attach:2,state_avail:2,state_confirm:2,state_connect:2,state_delet:2,state_dis:2,state_disconnect:2,state_down:2,state_en:2,state_error:2,state_inact:2,state_pend:2,state_reject:2,state_verifi:2,statu:[2,3],status_fail:2,status_messag:2,status_succeed:2,std:[2,3,4,5],str:[2,3,5,6],string:[3,6],struct:2,stub:[1,2,3,4,5],stub_config:[1,2,3,4,5],stubconfigur:[1,2,3,4,5],stubfactori:[1,2,3,4,5],stubfactorybas:[1,2,3,4,5],submodul:[0,7],subnet:2,subpackag:7,succe:2,succeed:2,success:2,suppli:[2,5],support:6,synchron:3,system:[2,3,6],tabl:2,tag:2,task:2,tgw:2,tgw_attachment_id:2,tgw_id:2,thi:[2,3,4,5,6],through:[2,3],tier:2,time:2,traffic:2,transmiss:2,tri:2,tunnel:2,two:6,type:[2,3,4,5],unauthor:[2,3,4,5],unavail:[2,3,4,5],unit:2,unknown:[3,6],updat:[2,3],uplink:2,use:[2,3,6],used:[2,3,4,5],user:[2,3],using:2,valid:2,valu:[2,3,5,6],vapi:[1,2,3,4,5,6],vapiinterfac:[2,3,4,5],vapistruct:2,variabl:6,variou:5,verifi:2,version:6,vgw:[2,3],via:2,vif:[2,3],vif_id:3,vifslistresult:[2,3],virtual:[2,3],virtualinterfac:2,vm_id:2,vmc:[2,3,4,5],vmcaccount:2,vmcconsolidatedrealizedstatu:[2,3],vmcconsolidatedstatu:2,vmcconsolidatedstatusperobject:2,vmcfeatureflag:2,vmcfeatureflaginfo:2,vmckeyvalueprovidergatewaylistpair:2,vmcprovidergatewai:2,vmware:[0,6,7],vpc:[2,3],vpn:2,vpn_dx_ip:2,vpn_endpoint:2,vpn_internet_ip:2,vpn_preferred_over_direct_connect:2,vpnendpoint:2,want:6,warn:2,were:2,what:[2,3],when:[2,6],where:2,which:[2,5,6],would:6,you:6,your:6,zone:2},titles:["com package","com.vmware package","com.vmware.nsx_vmc_app package","com.vmware.nsx_vmc_app.infra package","com.vmware.nsx_vmc_app.infra.direct_connect package","com.vmware.nsx_vmc_app.infra.external package","Interface definition language to python mapping for enumerated types","Welcome to NSX VMC AWS Integration API\u2019s documentation!"],titleterms:{AWS:7,api:7,code:6,com:[0,1,2,3,4,5],definit:6,direct_connect:4,direct_connect_cli:3,document:[6,7],enumer:6,exampl:6,extern:5,external_cli:3,indic:7,infra:[3,4,5],infra_cli:2,integr:7,interfac:6,languag:6,linked_vpcs_cli:3,map:6,model_cli:2,modul:[1,2,3,4,5],nsx:7,nsx_vmc_app:[2,3,4,5],nsx_vmc_app_client:1,nsx_vmc_app_client_for_vmc:1,packag:[0,1,2,3,4,5],python:6,realized_state_cli:3,routes_cli:[4,5],submodul:[1,2,3,4,5],subpackag:[0,1,2,3],tabl:7,type:6,vmc:7,vmware:[1,2,3,4,5],welcom:7}})