Environment management XML API. All methods are available only for the root customer and only in the first environment. All methods support trusted mode, in which case the i_customer parameter must be supplied.


listSwitchIPs()

This application lists IP addresses configured on the softswitch. Only IP addresses with AVAILABLE status can be assigned to an environment.

Parameters:

None.

Returns:

  • result - OK on success. String.
  • ips- array of structures:
    • ip - IP address. String.
    • status- IP address status. String. Possible values:
      • AVAILABLE - the IP address can be assigned to an environment.
      • INUSE - the IP address is already assigned to an environment.

XMLRPC fault is returned in case of any error.

createEnvironment()

This application creates a new environment.

Required parameters:

  • name - environment name. String. Must be unique.
  • assigned_ips - comma-separated list of IP addresses assigned to the environment. String. NULL means unassigned.
  • https_cname - hostname for the HTTP server. String.

Optional parameters:

  • max_cps - CPS limit. Integer. NULL means unlimited.
  • max_sessions - concurrent sessions limit. Integer. NULL means unlimited.
  • description - environment description. String.
  • installed_modules - comma-separated list of modules installed in the environment. String.
  • enable_sysinfo - enables System Information for the environment. Boolean.
  • enable_netband - enables Network Bandwidth for the environment. Boolean.
  • enable_cpuutil - enables CPU Utilization for the environment. Boolean.
  • enable_diskload - enables Disk Load for the environment. Boolean.
  • expiration_date - expiration date in %H:%M:%S.000 GMT %a %b %d %Y format. String.
  • notify_on_expiration - sends a notification when the environment expires. Boolean.
  • notify_addresses- comma-separated list of e-mail addresses used for expiration notifications. String. Special values are supported:
    • < E-Mail, CC, BCC > - use e-mail, cc, and bcc values from contact info.
    • < E-Mal > - use e-mail from contact info.
    • < CC > - use cc from contact info.
    • < BCC > - use bcc from contact info.
  • httpd_servers - number of HTTP servers to allocate. Integer. 0 means auto.
  • siplog_index_enabled - enables SIP log indexing. Boolean.
  • record_sdp - records SDP in SIP log. Boolean.
  • company_name - company name. String.
  • salutation - salutation. String.
  • first_name - first name. String.
  • last_name - last name. String.
  • mid_init - middle initial. String.
  • street_addr - street address. String.
  • state - state or province. String.
  • postal_code - postal code. String.
  • city - city. String.
  • country - country or region. String.
  • contact - contact person. String.
  • phone - phone number. String.
  • fax - fax number. String.
  • alt_phone - alternative phone number. String.
  • alt_contact - alternative contact person. String.
  • email - e-mail address. String.
  • cc - cc e-mail address list. String.
  • bcc - bcc e-mail address list. String.

Returns:

  • result - OK on success. String.
  • i_environment - ID of the newly created environment. Integer.

XMLRPC fault is returned in case of any error.

updateEnvironment()

This application updates an environment.

Required parameters:

  • i_environment - ID of the environment to update. Integer.

Optional parameters:

  • Any parameter accepted by createEnvironment().

Returns:

  • result - OK on success. String.

XMLRPC fault is returned in case of any error.

getEnvironmentInfo()

This application returns all attributes of a single environment.

Required parameters:

  • i_environment - ID of the environment. Integer.

Returns:

  • result - OK on success. String.
  • environment- structure containing the environment attributes:
    • i_environment - Integer.
    • name - String.
    • assigned_ips - comma-separated list of assigned IP addresses. String.
    • https_cname - String.
    • max_cps - Integer.
    • max_sessions - Integer.
    • description - String.
    • installed_modules - String.
    • enable_sysinfo - Boolean.
    • enable_netband - Boolean.
    • enable_cpuutil - Boolean.
    • enable_diskload - Boolean.
    • expiration_date - String.
    • notify_on_expiration - Boolean.
    • notify_addresses - String.
    • httpd_servers - Integer.
    • enabled - Boolean.
    • suspend_date - String.
    • pending_action - String.
    • siplog_index_enabled - Boolean.
    • record_sdp - Boolean.
    • company_name - String.
    • salutation - String.
    • first_name - String.
    • last_name - String.
    • mid_init - String.
    • street_addr - String.
    • state - String.
    • postal_code - String.
    • city - String.
    • country - String.
    • contact - String.
    • phone - String.
    • fax - String.
    • alt_phone - String.
    • alt_contact - String.
    • email - String.
    • cc - String.
    • bcc - String.
    • db_info- database size information. The structure contains:
      • main_master, main_slave, cdrs_master, cdrs_slave, balances_master, balances_slave.
      • Each entry contains size, size_pretty, and node_id.
    • When database information cannot be collected, the value is N/A.

XMLRPC fault is returned in case of any error.

listEnvironments()

This application returns a list of environments.

Optional parameters:

  • limit - maximum number of records to return. Integer.
  • offset - number of records to skip. Integer. Defaults to 0.

Returns:

  • result - OK on success. String.
  • environments- array of structures:
    • i_environment - Integer.
    • name - String.
    • https_cname - String.
    • max_cps - Integer.
    • max_sessions - Integer.
    • description - String.
    • expiration_date - String.
    • enabled - Boolean.
    • suspend_date - String.
    • pending_action - String.
    • db_name - String.
    • cdrs_db_name - String.
    • balances_db_name - String.
    • db_info - database size information, or N/A if unavailable.

XMLRPC fault is returned in case of any error.

queueEnvironmentAction()

This application queues an action for an environment.

Required parameters:

  • i_environment - ID of the environment. Integer.
  • action- action to queue. String. Possible values:
    • start - start the environment.
    • stop - stop the environment.
    • restart - restart the environment.
    • suspend - suspend the environment.
    • delete - delete the environment.

Optional parameters:

  • suspend_message - message shown on the web interface when the environment is suspended. String. The ${DATE} macro is replaced with the suspension date.

Returns:

  • result - OK on success. String.

XMLRPC fault is returned in case of any error.