31 imconfutil Command Reference

set-prop property

Sets a configuration property.

del-prop property

Deletes a configuration property.

get-prop property

Lists the value of a configuration property. The get-prop command, with the -c option, but without a specific property, displays the values of all properties.

verify property password

Verifies that a specified password property (for example, iim_ldap.usergroupbindcred) is set to the given cleartext string in the iim.conf.xml file.

add-ldap-replica id=id host=host [port=port] [usessl=true | false]

Adds a new LDAP replica description. id is a unique name for the LDAP replica. host is the host name or IP address of the LDAP replica. port is the port number on which the LDAP replica listens. usessl specifies whether to use SSL when connecting to this LDAP replica.

delete-ldap-replica id

Deletes an existing LDAP replica description entry.

set-ldap-replica-prop id[host=host] [port=port] [usessl= true | false]

Modifies the properties of an LDAP replica description entry. id is a unique name for the LDAP replica. host is the host name or IP address of the LDAP replica. port is the port number on which the LDAP replica listens. usessl specifies whether to use SSL when connecting to this LDAP replica.

get-ldap-replica-prop id

Lists the properties of an LDAP replica description.

list-ldap-replicas

Displays a list of LDAP replica description entries.

add-component id=id jid=jid [password=password] [broadcastpresence=true | false]

Adds a component. id can be any string, but it is convenient to use something that identifies the component, such as calagent, httpbind, msngateway, aimgateway, smsgateway, or yimgateway. jid is the jabber ID to bind the component to the Instant Messaging server. password authenticates the component to the Instant Messaging server. broadcastpresence is for use when the Web Presence API is added. If set to true, it allows Instant Messaging Server to send presence information to the Web Presence API.

delete-component id

Deletes an existing component description entry.

set-component-prop id property= value [property= value...]

Modifies the properties of a component description entry.

get-component-prop id

Lists the properties of a component description.

verify-component-pass id password

Verifies that the component with the specified ID has the specified cleartext password in the iim.conf.xml file.

list-components

Displays a list of component description entries.

add-coserver id serverid password host [requiressl= true | false] domain

Adds a new coserver description. id is a unique name for this coserver entry. serverid is the server ID used to identify this coserver, and should be the same as mentioned in that coserver's configuration. password is used to authenticate this coserver. host is the host name or IP address of this coserver. requiressl specifies whether TLS is required when connecting to this coserver. domains specifies the domain served by this coserver.

delete-coserver id

Deletes an existing coserver description entry.

set-coserver-prop id property= value [property= value...]

Modifies the properties of a coserver description entry.

get-coserver-prop id [server id password host [requiressl=true | false domain]

Shows the properties of a coserver description. id is a unique name for this coserver entry. serverid is the server ID used to identify this coserver, and should be the same as mentioned in that coserver's configuration. password is used to authenticate this coserver. host is the host name or IP address of this coserver. requiressl specifies whether TLS is required when connecting to this coserver. domains specifies the domain served by this coserver.

verify-coserver-pass id password

Verifies that the coserver whose ID is id has the specified cleartext password in the iim.conf.xml file.

list-coservers

Displays a list of coserver description entries.

add-server-threadpool id=id maxthreads= maxthreads [capacity=capacity]

Adds a new server threadpool entry.

delete-server-threadpool

Deletes an existing server threadpool entry.

set-server-threadpool-prop

Modifies the properties of a server threadpool entry.

get-server-threadpool readpool-prop id maxthreads=maxthreads capacity=capacity

Displays the properties of a server threadpool entry.

list-server-threadpools

Displays a list of server threadpools.

set-default-server-threadpool id

Sets the default server threadpool.

get-default-server-threadpool

Displays the default server threadpool ID.

add-mux-threadpool id=id maxthreads=maxthreads [capacity=capacity]

Adds a new multiplexor threadpool entry.

delete-mux-threadpool id

Deletes an existing multiplexor threadpool entry.

set-mux-threadpool-prop id property= value [property= value...]

Modifies the properties of a multiplexor threadpool entry.

get-mux-threadpool-prop id maxthreads capacity

Displays the properties of a multiplexor threadpool entry.

list-mux-threadpools

Displays a list of multiplexor threadpools.

set-default-mux-threadpool id

Sets the default multiplexor threadpool.

get-default-mux-threadpool

Displays the default multiplexor threadpool ID.

add-listener id=id port=port protocols=protocols [property=value...]

Adds a new listener entry.

delete-listener id

Deletes a listener entry.

set-listener-prop id property= value [property= value...]

Modifies the properties of a listener entry.

get-listener-prop id [property1 property2...]

Displays the properties of a listener entry.

list-listeners

Displays a list of listeners.

add-jmqbrokerid= id address= hostnameport: user=broker_name password=broker_password

Adds a JMQ broker for handling calendar availability notifications.

delete-jmqbroker id

Deletes a JMQ broker.

list-jmqbrokers

Lists the IDs of all JMQ brokers. The properties of an individual broker can then be obtained using the imconfutil get-jmqbroker-prop command.

set-jmqbroker-prop id property= value [property= value...]

Sets one or more properties of a JMQ broker. To set more than one property, enter a space-separated list of property=value pairs. The properties you can set are:

• address: the host name and port (hostname:port) of the JMQ publisher that the calendar-agent broker communicates with. The JMQ publisher is a part of Calendar Server.

• user: The user name for the broker to use in connecting to Instant Messaging Server.

• password: The password for the broker to use in connecting to Instant Messaging Server.

get-jmqbroker-prop id

Gets the properties of the JMQ broker with the specified ID.

verify-jmqbroker-pass id password

Verifies that the JMQ broker whose ID is id has the specified cleartext password in the iim.conf.xml file.

generate-password [-k | keyfile path_to_key_file] plaintext_password

Encrypts a given plaintext password and prints it out. Use this command when to change an individual password in an Instant Messaging Server state file. For information on state files, see Instant Messaging Server Installation and Configuration Guide.

If you do not provide the plaintext_password with the generate-password command, the imconfig utility prompts you to enter the plaintext_password twice, and then generates the encrypted password

The -k option is mandatory.

rekey

Generate a new encryption key and newly encrypted passwords for all current Instant Messaging Server passwords.

generate-key

Generate an encryption key and output it to the console. You can send the key to a file, which can then be used to create new encrypted passwords for a silent configuration.

add-plugin id [enable] [handlerclass] [namespace] type

Adds a new plugin.

delete-plugin id

Deletes a plugin.

set-plugin-prop id property=value [property=value ...]

Modifies plugin properties.

get-plugin-prop id [enable] [handlerclass] [namespace] [type]

Shows plugin properties.

list-plugins

Shows all plugins.