Modify Organization operation


The Modify Organization operation enables you to update an existing vCloud organization. Only the vCloud system administrator can perform this operation.

The following figure shows a sample <items> XML element for the Modify Organization operation.

Warning

The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

<items>
 <item>
   <parameters>
     <organization-id></organization-id>
     <modify-organization-params>
       <organization-name></organization-name>
       <full-name></full-name>
       <settings>
         <is-enabled></is-enabled>
         <can-publish-catalogs></can-publish-catalogs>
         <org-lease-settings>
           <deployment-lease-seconds></deployment-lease-seconds>
           <storage-lease-seconds></storage-lease-seconds>
           <delete-on-storage-lease-expiration>
</delete-on-storage-lease-expiration>
         </org-lease-settings>
         <org-ldap-mode></org-ldap-mode>
         <org-ldap-settings>
           <host-name></host-name>
           <port>39</port>
           <is-ssl></is-ssl>
           <is-ssl-accept-all></is-ssl-accept-all>
           <realm></realm>
           <search-base></search-base>
           <ldap-user-name></ldap-user-name>
           <ldap-password>root@</ldap-password>
           <authentication-mechanism></authentication-mechanism>
           <is-group-search-base-enabled></is-group-search-base-enabled>
           <connector-type>OPEN_</connector-type>
           <user-attributes>
             <user-object-class></user-object-class>
             <user-object-identifier></user-object-identifier>
             <user-email></user-email>
             <user-name></user-name>
             <user-full-name></user-full-name>
             <user-given-name></user-given-name>
             <user-surname></user-surname>
             <user-telephone></user-telephone>
             <group-membership-identifier></group-membership-identifier>
             <group-back-link-identifier></group-back-link-identifier>
           </user-attributes>
           <group-attributes>
             <group-object-identifier></group-object-identifier>
             <group-object-class></group-object-class>
             <group-name></group-name>
             <memberships></memberships>
             <membership-identifier></membership-identifier>
             <back-link-identifier></back-link-identifier>
           </group-attributes>
         </org-ldap-settings>
         <org-email-settings>
           <is-default-smtp-server></is-default-smtp-server>
           <is-default-org-email></is-default-org-email>
           <from-email-address></from-email-address>
           <default-subject-prefix></default-subject-prefix>
           <is-alert-email-to-all-admins></is-alert-email-to-all-admins>
           <smtp-server-settings>
             <is-use-authentication></is-use-authentication>
             <smtp-server-name></smtp-server-name>
             <smtp-server-user-name></smtp-server-user-name>
             <smtp-server-password></smtp-server-password>
           </smtp-server-settings>
         </org-email-settings>
       </settings>
     </modify-organization-params>
   </parameters>
 <item>
<items>

The following table describes the elements for this adapter request.

Warning

The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

The following figure shows the sample adapter request for the Modify Organization operation. 

Warning

The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

<vmware-vcloud-request>
 <operation-name>Modify_Organization</operation-name>
 <vcloud-organization>TestOrg</vcloud-organization>
 <user-name>TestUser</user-name>
 <password>Password</password>  
 <parameters>
   <organization-id>916305970</organization-id>
   <modify-organization-params>
     <organization-name>TOModifuser</organization-name>
     <full-name>newOrganization</full-name>
     <settings>
       <is-enabled>true</is-enabled>
       <can-publish-catalogs>true</can-publish-catalogs>
       <org-lease-settings>
         <deployment-lease-seconds>10800</deployment-lease-seconds>
         <storage-lease-seconds>10800</storage-lease-seconds>
         <delete-on-storage-lease-expiration>true
</delete-on-storage-lease-expiration>
       </org-lease-settings>
       <org-ldap-mode>CUSTOM</org-ldap-mode>
       <org-ldap-settings>
         <host-name>10.128.248.78</host-name>
         <port>389</port>
         <is-ssl>false</is-ssl>
         <is-ssl-accept-all>false</is-ssl-accept-all>
         <realm>TEST</realm>
         <search-base>cn=Usersshrya,dc=BMCDEV1,dc=com</search-base>
         <ldap-user-name>administrator</ldap-user-name>
         <ldap-password>root@123</ldap-password>
         <authentication-mechanism>KERBEROS</authentication-mechanism>
         <is-group-search-base-enabled>false</is-group-search-base-enabled>
         <connector-type>OPEN_LDAP</connector-type>
         <user-attributes>
           <user-object-class>Usertesti</user-object-class>
           <user-object-identifier>testname</user-object-identifier>
           <user-email>testail</user-email>
           <user-name>testname</user-name>
           <user-full-name>test</user-full-name>
           <user-given-name>test given </user-given-name>
           <user-surname>sh lastname</user-surname>
           <user-telephone>1234588888</user-telephone>
           <group-membership-identifier>sg</group-membership-identifier>
           <group-back-link-identifier>test  back link
</group-back-link-identifier>
         </user-attributes>
         <group-attributes>
           <group-object-identifier>test groupId</group-object-identifier>
           <group-object-class>test user</group-object-class>
           <group-name>test nameuser</group-name>
           <memberships>membertest</memberships>
           <membership-identifier>dnshryea</membership-identifier>
           <back-link-identifier>test back link </back-link-identifier>
         </group-attributes>
       </org-ldap-settings>
       <org-email-settings>
         <is-default-smtp-server>false</is-default-smtp-server>
         <is-default-org-email>true</is-default-org-email>
         <from-email-address>vcloud@abc.com</from-email-address>
         <default-subject-prefix>Mail from vCloud</default-subject-prefix>
         <is-alert-email-to-all-admins>true</is-alert-email-to-all-admins>
         <smtp-server-settings>
           <is-use-authentication>false</is-use-authentication>
           <smtp-server-name>smtpshryea.abc.com</smtp-server-name>
           <smtp-server-user-name>SMTP111111testUse2r</smtp-server-user-name>
           <smtp-server-password>shyerpwd</smtp-server-password>
         </smtp-server-settings>
       </org-email-settings>
     </settings>
   </modify-organization-params>
 </parameters>
</vmware-vcloud-request>

The following figure shows the response for the sample request.

Warning

The macro unmigrated-inline-wiki-markup from Confluence is no longer available.

<vmware-vcloud-response>
 <metadata>
   <status>success</status>
 </metadata>
 <status-line>
   <code>200</code>
   <reason>OK</reason>
 </status-line>
 <message-body>
   <AdminOrg name="TOModifuser" type="application/vnd.vmware.admin.
organization+xml"
href="https://10.128.248.112/api/v1.0/admin/org/916305970">
     <Link rel="down" type="application/vnd.vmware.vcloud.tasksList+xml"
href="https://10.128.248.112/api/v1.0/tasksList/916305970" />
     <Link rel="add" type="application/vnd.vmware.admin.catalog+xml"
href="https://10.128.248.112/api/v1.0/admin/org/916305970/catalogs" />
     <Link rel="add" type="application/vnd.vmware.admin.user+xml"
href="https://10.128.248.112/api/v1.0/admin/org/916305970/users" />
     <Link rel="add" type="application/vnd.vmware.admin.group+xml"
href="https://10.128.248.112/api/v1.0/admin/org/916305970/groups" />
     <Link rel="add" type="application/vnd.vmware.admin.vdc+xml"
href="https://10.128.248.112/api/v1.0/admin/org/916305970/vdcs" />
     <Link rel="add" type="application/vnd.vmware.admin.network+xml"
href="https://10.128.248.112/api/v1.0/admin/org/916305970/networks" />
     <Link rel="edit" type="application/vnd.vmware.admin.organization+xml"
href="https://10.128.248.112/api/v1.0/admin/org/916305970" />
     <Link rel="remove" href="https://10.128.248.112/api/v1.0/admin
/org/916305970"
/>
     <Link rel="disable" href="https://10.128.248.112/api/v1.0/admin
/org/916305970/
action/disable"
/>
     <Link rel="alternate" type="application/vnd.vmware.vcloud.org+xml"
href="https://10.128.248.112/api/v1.0/org/916305970" />
     <Description />
     <FullName>naya aur anaya Organization</FullName>
     <Settings>
       <IsEnabled>true</IsEnabled>
       <CanPublishCatalogs>true</CanPublishCatalogs>
       <DeployedVMQuota>0</DeployedVMQuota>
       <StoredVmQuota>0</StoredVmQuota>
       <OrgLeaseSettings>
         <DeleteOnStorageLeaseExpiration>true</DeleteOnStorageLeaseExpiration>
         <DeploymentLeaseSeconds>10800</DeploymentLeaseSeconds>
         <StorageLeaseSeconds>10800</StorageLeaseSeconds>
       </OrgLeaseSettings>
       <OrgLdapMode>CUSTOM</OrgLdapMode>
       <OrgLdapSettings>
         <HostName>10.128.248.78</HostName>
         <Port>389</Port>
         <IsSsl>false</IsSsl>
         <IsSslAcceptAll>false</IsSslAcceptAll>
         <Realm>TEST</Realm>
         <SearchBase>cn=Usersshrya,dc=BMCDEV1,dc=com</SearchBase>
         <UserName>administrator</UserName>
         <AuthenticationMechanism>KERBEROS</AuthenticationMechanism>
         <IsGroupSearchBaseEnabled>false</IsGroupSearchBaseEnabled>
         <ConnectorType>OPEN_LDAP</ConnectorType>
         <UserAttributes>
           <ObjectClass>Usertesti</ObjectClass>
           <ObjectIdentifier>testname</ObjectIdentifier>
           <UserName>testname</UserName>
           <Email>testail</Email>
           <FullName>test</FullName>
           <GivenName>test given</GivenName>
           <Surname>sh lastname</Surname>
           <Telephone>1234588888</Telephone>
           <GroupMembershipIdentifier>sg</GroupMembershipIdentifier>
         </UserAttributes>
         <GroupAttributes>
           <ObjectClass>test user</ObjectClass>
           <ObjectIdentifier>test groupId</ObjectIdentifier>
           <GroupName>test nameuser</GroupName>
           <Membership>membertest</Membership>
           <MembershipIdentifier>dnshryea</MembershipIdentifier>
         </GroupAttributes>
       </OrgLdapSettings>
       <OrgEmailSettings>
         <IsDefaultSmtpServer>false</IsDefaultSmtpServer>
         <IsDefaultOrgEmail>true</IsDefaultOrgEmail>
         <FromEmailAddress />
         <DefaultSubjectPrefix />
         <IsAlertEmailToAllAdmins>true</IsAlertEmailToAllAdmins>
         <SmtpServerSettings>
           <IsUseAuthentication>false</IsUseAuthentication>
           <Host>smtpshryea.abc.com</Host>
           <Username>SMTP111111testUse2r</Username>
         </SmtpServerSettings>
       </OrgEmailSettings>
       <DelayAfterPowerOnSeconds>2</DelayAfterPowerOnSeconds>
     </Settings>
     <Users />
     <Groups />
     <Catalogs>
       <CatalogReference type="application/vnd.vmware.admin.catalog+xml"
name="Catalog1" href="https://10.128.248.112/api/v1.0/admin/catalog
/1446916714"
/>
       <CatalogReference type="application/vnd.vmware.admin.catalog+xml"
name="BMCDevCatalog" href="https://10.128.248.112/api/v1.0/admin/catalog
/1545932923"
/>
     </Catalogs>
     <Vdcs />
     <Networks />
   </AdminOrg>
 </message-body>
</vmware-vcloud-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

(archive) BMC Atrium Orchestrator Application Adapters 20.12.01