Class: ZabbixManager::Configurations

Inherits:
Basic
  • Object
show all
Defined in:
lib/zabbix_manager/classes/configurations.rb

Instance Method Summary collapse

Methods inherited from Basic

#add, #all, #create, #create_or_update, #create_raw, #default_options, #delete, #delete_raw, #destroy, #dump_by_id, #get, #get_full_data, #get_id, #get_or_create, #get_raw, #hash_equals?, #identity_filter, #initialize, #key, #keys, #log, #normalize_hash, #parse_keys, #update, #update_raw

Constructor Details

This class inherits a constructor from ZabbixManager::Basic

Instance Method Details

#array_flag ⇒ Boolean

标记配置接口使用数组形式处理 API 返回值。

Returns:

  • (Boolean) —

    始终返回 true



7
8
9
 
# File 'lib/zabbix_manager/classes/configurations.rb', line 7

def array_flag
  true
end

#export(data) ⇒ Hash

通过 Zabbix API 导出配置数据。

Parameters:

  • data (Hash) —

    配置导出参数

Returns:

  • (Hash) —

    配置导出结果

Raises:

  • (ApiError) —

    Zabbix API 返回业务错误时抛出

  • (TransportError) —

    Zabbix 服务端返回非成功 HTTP 状态时抛出



31
32
33
 
# File 'lib/zabbix_manager/classes/configurations.rb', line 31

def export(data)
  @client.api_request(method: "configuration.export", params: data)
end

#identify ⇒ String

返回配置对象用于业务识别的字段名。

Returns:

  • (String) 


21
22
23
 
# File 'lib/zabbix_manager/classes/configurations.rb', line 21

def identify
  "host"
end

#import(data) ⇒ Hash

通过 Zabbix API 导入配置数据。

Parameters:

  • data (Hash) —

    配置导入参数及内容

Returns:

  • (Hash) —

    配置导入结果

Raises:

  • (ApiError) —

    Zabbix API 返回业务错误时抛出

  • (TransportError) —

    Zabbix 服务端返回非成功 HTTP 状态时抛出



41
42
43
 
# File 'lib/zabbix_manager/classes/configurations.rb', line 41

def import(data)
  @client.api_request(method: "configuration.import", params: data)
end

#method_name ⇒ String

返回配置对象对应的 Zabbix API 方法前缀。

Returns:

  • (String) 


14
15
16
 
# File 'lib/zabbix_manager/classes/configurations.rb', line 14

def method_name
  "configuration"
end