Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
CreateXMPPComponent SOAP Command

Create an XMPP component

Authorization token required true
Admin Authorization token required true

CreateXMPPComponentRequest

    <CreateXMPPComponentRequest> ## CreateXMPPComponentRequest
        <xmppcomponent name="{name}"> ## XMPPComponentSpec
            <domain [by="{domain-selector-by} (id|name|virtualHostname|krb5Realm|foreignName)"]>{key}</domain> ## DomainSelector
            <server [by="{server-by} (id|name|serviceHostname)"]>{key}</server> ## ServerSelector
            (<a n="{key}" /> ## Attr)*
        </xmppcomponent>
    </CreateXMPPComponentRequest>

The following table describes elements and attributes you can define within a <CreateXMPPComponentRequest> element:

XPath Required / Optional Description
/xmppcomponent Required (only 1) XMPP Component details
/xmppcomponent@name Required (only 1) Type:String
Name
/xmppcomponent/domain Required (only 1) Type:{key}
Domain selector
Description for element text content:The key used to identify the domain. Meaning determined by {domain-selector-by}
/xmppcomponent/domain@by Optional (0 or 1) Type:id|name|virtualHostname|krb5Realm|foreignName
Select the meaning of {domain-selector-key}
/xmppcomponent/server Required (only 1) Type:{key}
Server selector
Description for element text content:Key for choosing server
{server-by}="id" Use server's zimbraId as the Key
{server-by}="name" Use name of the server as the Key
{server-by}="serviceHostname" Use server's value for attr zimbraServiceHostname as the Key
/xmppcomponent/server@by Optional (0 or 1) Type:id|name|serviceHostname
Selects the meaning of {server-key}
/xmppcomponent/a Optional (0 or more) Attributes
/xmppcomponent/a@n Required (only 1) Type:String
Key

CreateXMPPComponentResponse

    <CreateXMPPComponentResponse> ## CreateXMPPComponentResponse
        <xmppcomponent name="{name}" id="{id}" [x-domainName="..."] [x-serverName="..."]> ## XMPPComponentInfo
            (<a n="{key}" /> ## Attr)*
        </xmppcomponent>
    </CreateXMPPComponentResponse>

The following table describes elements and attributes you can define within a <CreateXMPPComponentResponse> element:

XPath Required / Optional Description
/xmppcomponent Required (only 1) Information about the newly created XMPP component
/xmppcomponent@name Required (only 1) Type:String
Name
/xmppcomponent@id Required (only 1) Type:String
ID
/xmppcomponent@x-domainName Optional (0 or 1) Type:String
x-domainName
/xmppcomponent@x-serverName Optional (0 or 1) Type:String
x-serverName
/xmppcomponent/a Optional (0 or more) Attributes
/xmppcomponent/a@n Required (only 1) Type:String
Key