Module: Cvprac::Api::Configlet

Included in:
CvpApi
Defined in:
lib/cvprac/api/configlet.rb

Overview

CVP Configlet api methods rubocop:disable Metrics/ModuleLength

Configlet Method Summary collapse

Instance Method Details

#add_configlet(name, config) ⇒ String?

Add configlet

Examples:

result = api.add_configlet('api_test_3',
                           "interface Ethernet1\n   shutdown")

Parameters:

  • name (String) —

    The name of the desired configlet

  • config (String) —

    Multiline string of EOS configuration

Returns:

  • (String, nil) —

    The key for the new configlet. nil on failure

Raises:

  • CvpApiError on failure. Common: errorCode: 132518: Data already exists in Database.



56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/cvprac/api/configlet.rb', line 56

def add_configlet(name, config)
  log(Logger::DEBUG) do
    "add_configlet: #{name} Config: #{config.inspect}"
  end
  resp = @clnt.post('/configlet/addConfiglet.do',
                    body: { name: name, config: config.to_s }.to_json)
  log(Logger::DEBUG) do
    "add_configlet: #{name} Response: #{resp.inspect}"
  end
  resp['data']
end

#apply_configlets_to_device(app_name, device, new_configlets) ⇒ Hash

Apply configlets to a device

rubocop:disable Metrics/MethodLength, Metrics/AbcSize

Examples:

result = api.apply_configlets_to_device('test',
                                        {...},
                                        [{'name' => 'new_configlet',
                                          'key' => '...'}])
=> {"data"=>{"taskIds"=>["8"], "status"=>"success"}}

Parameters:

  • app_name (String) —

    The name to use in the info field

  • device (Hash) —

    Device definition from #get_device_by_id()

  • new_configlets (Hash) —

    List of configlet name & key pairs

Returns:

  • (Hash) —

    Hash including status and a list of task IDs created, if any



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/cvprac/api/configlet.rb', line 181

def apply_configlets_to_device(app_name, device, new_configlets)
  log(Logger::DEBUG) { "apply_configlets_to_device: #{app_name}" }

  # get the list of existing configlets
  configlets = get_configlets_by_device_id(device['systemMacAddress'])

  # Get a list of the configlet names and keys
  cnames = []
  ckeys = []
  configlets.each do |configlet|
    cnames << configlet['name']
    ckeys << configlet['key']
  end

  new_configlets.each do |configlet|
    cnames << configlet['name']
    ckeys << configlet['key']
  end

  info = "#{app_name}: Configlet Assign: to Device #{device['fqdn']}"
  info_preview = "<b>Configlet Assign:</b> to Device #{device['fqdn']}"
  data = { data: [{ id: 1,
                    info: info,
                    infoPreview: info_preview,
                    note: '',
                    action: 'associate',
                    nodeType: 'configlet',
                    nodeId: '',
                    configletList: ckeys,
                    configletNamesList: cnames,
                    ignoreConfigletNamesList: [],
                    ignoreConfigletList: [],
                    configletBuilderList: [],
                    configletBuilderNamesList: [],
                    ignoreConfigletBuilderList: [],
                    ignoreConfigletBuilderNamesList: [],
                    toId: device['systemMacAddress'],
                    toIdType: 'netelement',
                    fromId: '',
                    nodeName: '',
                    fromName: '',
                    toName: device['fqdn'],
                    nodeIpAddress: device['ipAddress'],
                    nodeTargetIpAddress: device['ipAddress'],
                    childTasks: [],
                    parentTask: '' }] }
  log(Logger::DEBUG) do
    "#{__method__}: saveTopology data #{data['data']}"
  end
  add_temp_action(data)
  save_topology_v2([])
end

#delete_configlet(name, key) ⇒ String

Delete configlet

Parameters:

  • name (String) —

    The name of the desired configlet

  • key (String) —

    The configlet key

Returns:

  • (String) —

    The request result

Raises:

  • CvpApiError on failure. Common when name or key is invalid: errorCode: 132718: Invalid input parameters.



98
99
100
101
102
103
 
# File 'lib/cvprac/api/configlet.rb', line 98

def delete_configlet(name, key)
  log(Logger::DEBUG) { "delete_configlet: #{name} Key: #{key}" }
  resp = @clnt.post('/configlet/deleteConfiglet.do',
                    body: [{ name: name, key: key }].to_json)
  resp['data']
end

#get_configlet_by_name(name) ⇒ Hash

Get configlet definition by configlet name

Examples:

configlet = api.get_configlet_by_name('api_test_3')

Parameters:

  • name (String) —

    The name of the desired configlet

Returns:

  • (Hash) —

    configlet definition



134
135
136
137
 
# File 'lib/cvprac/api/configlet.rb', line 134

def get_configlet_by_name(name)
  log(Logger::DEBUG) { "get_configlet_by_name: #{name}" }
  @clnt.get('/configlet/getConfigletByName.do', data: { name: name })
end

#get_configlets(start_i = 0, end_i = 0, type = 'Configlet') ⇒ Hash

Get all configlet definitions

Examples:

configlet = api.get_configlets()

Parameters:

  • start_i (Fixnum) (defaults to: 0) —

    (0) Start index of pagination

  • end_i (Fixnum) (defaults to: 0) —

    (0) End index for pagination. 0 will get all

  • type (String) (defaults to: 'Configlet') —

    (‘Configlet’) Possible types are All, Configlet, Builder, Draft, Builderwithoutdraft, Generated, IgnoreDraft

Returns:

  • (Hash) —

    configlet definitions with keys: total and data (a list of definitions)



117
118
119
120
121
122
123
124
 
# File 'lib/cvprac/api/configlet.rb', line 117

def get_configlets(start_i = 0, end_i = 0, type = 'Configlet')
  log(Logger::DEBUG) do
    "get_configlets: start=#{start_i}, end=#{end_i}, type=#{type}"
  end
  @clnt.get('/configlet/getConfiglets.do', data: { startIndex: start_i,
                                                   endIndex: end_i,
                                                   type: type })
end

#get_devices_by_configlet_name(name, **opts) ⇒ Hash

Get devices associated with a configlet name

Examples:

configlet = api.get_configlet_by_name('api_test_3')

Parameters:

  • name (String) —

    The name of the desired configlet

  • opts (Hash) —

    Optional arguments

Options Hash (**opts):

  • :queryparam (String) —

    Search string

  • :start_index (Fixnum) — default: 0 —

    Start index for pagination

  • :end_index (Fixnum) — default: 0 —

    End index for pagination

Returns:

  • (Hash) —

    configlet definition



152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/cvprac/api/configlet.rb', line 152

def get_devices_by_configlet_name(name, **opts)
  opts = { queryparam: nil,
           start_index: 0,
           end_index: 0 }.merge(opts)
  log(Logger::DEBUG) { "get_configlet_by_name: #{name}" }
  @clnt.get('/configlet/getAppliedDevices.do',
            data: { configletName: name,
                    queryparam: opts[:queryparam],
                    startIndex: opts[:start_index],
                    endIndex: opts[:end_index] })
end

#remove_configlets_from_device(app_name, device, configlets) ⇒ Hash

Remove configlets from a device

Examples:

result = api.remove_configlets_from_device('test',
                                           {...},
                                           [{'name' => 'configlet',
                                             'key' => '...'}])
=> {"data"=>{"taskIds"=>["8"], "status"=>"success"}}

Parameters:

  • app_name (String) —

    The name to use in the info field

  • device (Hash) —

    Device definition from #get_device_by_id()

  • configlets (Hash) —

    List of configlet name & key pairs to remove

Returns:

  • (Hash) —

    Hash including status and a list of task IDs created, if any



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/cvprac/api/configlet.rb', line 250

def remove_configlets_from_device(app_name, device, configlets)
  log(Logger::DEBUG) { "#{__method__}: #{app_name}" }

  # get the list of existing configlets
  curr_cfglts = get_configlets_by_device_id(device['systemMacAddress'])

  # Get a list of the configlet names and keys
  keep_cnames = []
  keep_ckeys = []
  curr_cfglts.each do |configlet|
    next if configlets.include?('name' => configlet['name'],
                                'key' => configlet['key'])
    keep_cnames << configlet['name']
    keep_ckeys << configlet['key']
  end

  del_cnames = []
  del_ckeys = []
  configlets.each do |configlet|
    del_cnames << configlet['name']
    del_ckeys << configlet['key']
  end

  info = "#{app_name}: Configlet Remove from Device #{device['fqdn']}"
  info_preview = "<b>Configlet Remove:</b> from Device #{device['fqdn']}"
  data = { data: [{ id: 1,
                    info: info,
                    infoPreview: info_preview,
                    note: '',
                    action: 'associate',
                    nodeType: 'configlet',
                    nodeId: '',
                    configletList: keep_ckeys,
                    configletNamesList: keep_cnames,
                    ignoreConfigletNamesList: del_cnames,
                    ignoreConfigletList: del_ckeys,
                    configletBuilderList: [],
                    configletBuilderNamesList: [],
                    ignoreConfigletBuilderList: [],
                    ignoreConfigletBuilderNamesList: [],
                    toId: device['systemMacAddress'],
                    toIdType: 'netelement',
                    fromId: '',
                    nodeName: '',
                    fromName: '',
                    toName: device['fqdn'],
                    nodeIpAddress: device['ipAddress'],
                    nodeTargetIpAddress: device['ipAddress'],
                    childTasks: [],
                    parentTask: '' }] }
  log(Logger::DEBUG) do
    "#{__method__}: saveTopology data #{data['data']}"
  end
  add_temp_action(data)
  save_topology_v2([])
end

#update_configlet(name, key, config) ⇒ String

Update configlet

Examples:

result = api.update_configlet('api_test_3', configlet_new['key'],
                              "interface Ethernet1\n   shutdown")

Parameters:

  • name (String) —

    The name of the desired configlet

  • key (String) —

    The configlet key

  • config (Hash) —

    The configlet definition

Returns:

  • (String) —

    The key for the new configlet



79
80
81
82
83
84
85
86
87
 
# File 'lib/cvprac/api/configlet.rb', line 79

def update_configlet(name, key, config)
  log(Logger::DEBUG) do
    "update_configlet: #{name} Key: #{key} Config: #{config.inspect}"
  end
  data = @clnt.post('/configlet/updateConfiglet.do',
                    body: { name: name, key: key,
                            config: config }.to_json)
  data['data']
end