sync.slave

Description

Contains methods to set up information about allowed-"slaves", for use on the "master" side of ISS

Namespace:

sync.slave

Method: create

Description:

Create a new Slave, known to this Master.

Parameters:

  • string sessionKey

  • string slave - Slave’s fully-qualified domain name

  • boolean enabled - Let this slave talk to us?

  • boolean allowAllOrgs - Export all our orgs to this slave?

Returns:

  • * struct - IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"

Method: delete

Description:

Remove the specified Slave

Parameters:

  • string sessionKey

  • int id - Id of the Slave to remove

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: getAllowedOrgs

Description:

Get all orgs this Master is willing to export to the specified Slave

Parameters:

  • string sessionKey

  • int id - Id of the desired Slave

Returns:

  • array :

    • int - ids of allowed organizations

Method: getSlave

Description:

Find a Slave by specifying its ID

Parameters:

  • string sessionKey

  • int id - Id of the desired Slave

Returns:

  • * struct - IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"

Method: getSlaveByName

Description:

Find a Slave by specifying its Fully-Qualified Domain Name

Parameters:

  • string sessionKey

  • string fqdn - Domain-name of the desired Slave

Returns:

  • * struct - IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"

Method: getSlaves

Description:

Get all the Slaves this Master knows about

Parameters:

  • string sessionKey

Returns:

  • array :

  • struct - IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"

Method: setAllowedOrgs

Description:

Set the orgs this Master is willing to export to the specified Slave

Parameters:

  • string sessionKey

  • int id - Id of the desired Slave

  • array :

    • int - List of org-ids we’re willing to export

Returns:

  • int - 1 on success, exception thrown otherwise.

Method: update

Description:

Updates attributes of the specified Slave

Parameters:

  • string sessionKey

  • int id - Id of the Slave to update

  • string slave - Slave’s fully-qualified domain name

  • boolean enabled - Let this slave talk to us?

  • boolean allowAllOrgs - Export all our orgs to this Slave?

Returns:

  • * struct - IssSlave info

    • int "id"

    • string "slave"

    • boolean "enabled"

    • boolean "allowAllOrgs"