OSTIP_EXARI

v0.1.0

OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocsasteriskFormat View Source

API calls for all endpoints tagged ApiDocsasteriskFormat.

Link to this section Summary

Functions

add_log(connection, log_channel_name, configuration, opts \\ [])

Adds a log channel

delete_log(connection, log_channel_name, opts \\ [])

Deletes a log channel

delete_object(connection, config_class, object_type, id, opts \\ [])

Delete a dynamic configuration object

get_global_var(connection, variable, opts \\ [])

Get the value of a global variable

get_info(connection, opts \\ [])

Gets Asterisk system information

get_module(connection, module_name, opts \\ [])

Get Asterisk module information

get_object(connection, config_class, object_type, id, opts \\ [])

Retrieve a dynamic configuration object

list_log_channels(connection, opts \\ [])

Gets Asterisk log channel information

list_modules(connection, opts \\ [])

List Asterisk modules

load_module(connection, module_name, opts \\ [])

Load an Asterisk module

reload_module(connection, module_name, opts \\ [])

Reload an Asterisk module

rotate_log(connection, log_channel_name, opts \\ [])

Rotates a log channel

set_global_var(connection, variable, opts \\ [])

Set the value of a global variable

unload_module(connection, module_name, opts \\ [])

Unload an Asterisk module

update_object(connection, config_class, object_type, id, opts \\ [])

Create or update a dynamic configuration object

Link to this section Functions

Link to this function add_log(connection, log_channel_name, configuration, opts \\ []) View Source 
add_log(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Adds a log channel.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • log_channel_name (String.t): The log channel to add
  • configuration (String.t): levels of the log channel
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function delete_log(connection, log_channel_name, opts \\ []) View Source 
delete_log(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Deletes a log channel.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • log_channel_name (String.t): Log channels name
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function delete_object(connection, config_class, object_type, id, opts \\ []) View Source 
delete_object(Tesla.Env.client(), String.t(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Delete a dynamic configuration object.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • config_class (String.t): The configuration class containing dynamic configuration objects.
  • object_type (String.t): The type of configuration object to delete.
  • id (String.t): The unique identifier of the object to delete.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function get_global_var(connection, variable, opts \\ []) View Source 
get_global_var(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Get the value of a global variable.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • variable (String.t): The variable to get
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function get_info(connection, opts \\ []) View Source 
get_info(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}

Gets Asterisk system information.

Parameters

  • connection (Swagger.Client.Connection): Connection to server

  • opts (KeywordList): [optional] Optional parameters

    • :only ([String.t]): Filter information returned

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function get_module(connection, module_name, opts \\ []) View Source 
get_module(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Get Asterisk module information.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • module_name (String.t): Module's name
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function get_object(connection, config_class, object_type, id, opts \\ []) View Source 
get_object(Tesla.Env.client(), String.t(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Retrieve a dynamic configuration object.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • config_class (String.t): The configuration class containing dynamic configuration objects.
  • object_type (String.t): The type of configuration object to retrieve.
  • id (String.t): The unique identifier of the object to retrieve.
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function list_log_channels(connection, opts \\ []) View Source 
list_log_channels(Tesla.Env.client(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Gets Asterisk log channel information.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function list_modules(connection, opts \\ []) View Source 
list_modules(Tesla.Env.client(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

List Asterisk modules.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function load_module(connection, module_name, opts \\ []) View Source 
load_module(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Load an Asterisk module.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • module_name (String.t): Module's name
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function reload_module(connection, module_name, opts \\ []) View Source 
reload_module(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Reload an Asterisk module.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • module_name (String.t): Module's name
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function rotate_log(connection, log_channel_name, opts \\ []) View Source 
rotate_log(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Rotates a log channel.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • log_channel_name (String.t): Log channel's name
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function set_global_var(connection, variable, opts \\ []) View Source 
set_global_var(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Set the value of a global variable.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • variable (String.t): The variable to set

  • opts (KeywordList): [optional] Optional parameters

    • :value (String.t): The value to set the variable to

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function unload_module(connection, module_name, opts \\ []) View Source 
unload_module(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Unload an Asterisk module.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • module_name (String.t): Module's name
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function update_object(connection, config_class, object_type, id, opts \\ []) View Source 
update_object(Tesla.Env.client(), String.t(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:error, Tesla.Env.t()}

Create or update a dynamic configuration object.

Parameters

  • connection (Swagger.Client.Connection): Connection to server
  • config_class (String.t): The configuration class containing dynamic configuration objects.
  • object_type (String.t): The type of configuration object to create or update.
  • id (String.t): The unique identifier of the object to create or update.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (Containers): The body object should have a value that is a list of ConfigTuples, which provide the fields to update. Ex. [ { "attribute": "directmedia", "value": "false" } ]

Returns

{:ok, %{}} on success {:error, info} on failure