libsolace.items.SolaceUsers module

class libsolace.items.SolaceUsers.SolaceUsers[source]

Manage dict of client-users within Solace

api = 'None'
check_acl_profile_exists(**kwargs)[source]

Check if the acl profile already exists

Parameters:acl_profile (str) – the acl profile name
Returns:boolean
Return type:bool
check_client_profile_exists(**kwargs)[source]

Checks if a client_profile exists on the appliance for linking.

Example:

>>> from libsolace.SolaceAPI import SolaceAPI
>>> apic = SolaceAPI("dev")
>>> foo = apic.manage("SolaceUser")
>>> foo.check_client_profile_exists(client_profile="default")
True
Parameters:client_profile (str) – the client profile name
Returns:boolean
Return type:bool
create_user(**kwargs)[source]

Create the user

Parameters:
  • username (str) – the username
  • vpn_name (str) – the vpn name
Return type:

plugin.PluginResponse
Returns:

SEMP request
disable_user(*args, **kwargs)[source]

Disable the user ( suspending pub/sub )

Parameters:
  • username (str) – the username
  • vpn_name (str) – the vpn name
  • shutdown_on_apply (bool / char) – see Kwargs.shutdown_on_apply()
Return type:

plugin.PluginResponse
Returns:

SEMP request
get(**kwargs)[source]

Get a username from solace, return a dict

no_guarenteed_endpoint(**kwargs)[source]

no guaranteed endpoint

Parameters:
  • username (str) – the username
  • vpn_name (str) – the vpn name
Return type:

plugin.PluginResponse
Returns:

SEMP request
no_shutdown_user(**kwargs)[source]

Enable the user

Parameters:
  • username (str) – the username
  • vpn_name (str) – the vpn name
Return type:

plugin.PluginResponse
Returns:

SEMP request
no_subscription_manager(**kwargs)[source]

no subscription manager

Parameters:
  • username (str) – the username
  • vpn_name (str) – the vpn name
Return type:

plugin.PluginResponse
Returns:

SEMP request
plugin_name = 'SolaceUsers'
set_acl_profile(*args, **kwargs)[source]

set acl profile

Parameters:
  • username (str) – the username
  • vpn_name (str) – the vpn name
  • acl_profile (str) – name of the profile
Return type:

plugin.PluginResponse
Returns:

SEMP request
set_client_profile(*args, **kwargs)[source]

set client profile

Parameters:
  • username (str) – the username
  • vpn_name (str) – the vpn name
  • client_profile (str) – name of the profile
Return type:

plugin.PluginResponse
Returns:

SEMP request
set_password(**kwargs)[source]

Set the user password

Parameters:
  • username (str) – the username
  • vpn_name (str) – the vpn name
  • password (str) – the password
Return type:

plugin.PluginResponse
Returns:

SEMP request