Module: NetboxClientRuby

Extended by:
Dry::Configurable
Defined in:
lib/netbox_client_ruby.rb,
lib/netbox_client_ruby/error.rb,
lib/netbox_client_ruby/entity.rb,
lib/netbox_client_ruby/version.rb,
lib/netbox_client_ruby/api/dcim.rb,
lib/netbox_client_ruby/api/ipam.rb,
lib/netbox_client_ruby/entities.rb,
lib/netbox_client_ruby/api/extras.rb,
lib/netbox_client_ruby/connection.rb,
lib/netbox_client_ruby/api/secrets.rb,
lib/netbox_client_ruby/api/tenancy.rb,
lib/netbox_client_ruby/api/circuits.rb,
lib/netbox_client_ruby/api/ipam/rir.rb,
lib/netbox_client_ruby/api/ipam/vrf.rb,
lib/netbox_client_ruby/api/dcim/rack.rb,
lib/netbox_client_ruby/api/dcim/site.rb,
lib/netbox_client_ruby/api/ipam/rirs.rb,
lib/netbox_client_ruby/api/ipam/role.rb,
lib/netbox_client_ruby/api/ipam/vlan.rb,
lib/netbox_client_ruby/api/ipam/vrfs.rb,
lib/netbox_client_ruby/communication.rb,
lib/netbox_client_ruby/api/dcim/racks.rb,
lib/netbox_client_ruby/api/dcim/sites.rb,
lib/netbox_client_ruby/api/extras/tag.rb,
lib/netbox_client_ruby/api/ipam/roles.rb,
lib/netbox_client_ruby/api/ipam/vlans.rb,
lib/netbox_client_ruby/api/dcim/device.rb,
lib/netbox_client_ruby/api/dcim/region.rb,
lib/netbox_client_ruby/api/extras/tags.rb,
lib/netbox_client_ruby/api/ipam/prefix.rb,
lib/netbox_client_ruby/api/dcim/devices.rb,
lib/netbox_client_ruby/api/dcim/regions.rb,
lib/netbox_client_ruby/api/ipam/service.rb,
lib/netbox_client_ruby/api/dcim/location.rb,
lib/netbox_client_ruby/api/dcim/platform.rb,
lib/netbox_client_ruby/api/ipam/ip_range.rb,
lib/netbox_client_ruby/api/ipam/prefixes.rb,
lib/netbox_client_ruby/api/ipam/services.rb,
lib/netbox_client_ruby/api/dcim/interface.rb,
lib/netbox_client_ruby/api/dcim/locations.rb,
lib/netbox_client_ruby/api/dcim/platforms.rb,
lib/netbox_client_ruby/api/dcim/rack_role.rb,
lib/netbox_client_ruby/api/dcim/rear_port.rb,
lib/netbox_client_ruby/api/ipam/aggregate.rb,
lib/netbox_client_ruby/api/ipam/ip_ranges.rb,
lib/netbox_client_ruby/api/secrets/secret.rb,
lib/netbox_client_ruby/api/tenancy/tenant.rb,
lib/netbox_client_ruby/api/virtualization.rb,
lib/netbox_client_ruby/api/dcim/front_port.rb,
lib/netbox_client_ruby/api/dcim/interfaces.rb,
lib/netbox_client_ruby/api/dcim/power_port.rb,
lib/netbox_client_ruby/api/dcim/rack_group.rb,
lib/netbox_client_ruby/api/dcim/rack_roles.rb,
lib/netbox_client_ruby/api/dcim/rear_ports.rb,
lib/netbox_client_ruby/api/ipam/aggregates.rb,
lib/netbox_client_ruby/api/ipam/ip_address.rb,
lib/netbox_client_ruby/api/ipam/vlan_group.rb,
lib/netbox_client_ruby/api/secrets/secrets.rb,
lib/netbox_client_ruby/api/tenancy/contact.rb,
lib/netbox_client_ruby/api/tenancy/tenants.rb,
lib/netbox_client_ruby/api/circuits/circuit.rb,
lib/netbox_client_ruby/api/dcim/device_role.rb,
lib/netbox_client_ruby/api/dcim/device_type.rb,
lib/netbox_client_ruby/api/dcim/front_ports.rb,
lib/netbox_client_ruby/api/dcim/mac_address.rb,
lib/netbox_client_ruby/api/dcim/power_ports.rb,
lib/netbox_client_ruby/api/dcim/rack_groups.rb,
lib/netbox_client_ruby/api/ipam/vlan_groups.rb,
lib/netbox_client_ruby/api/tenancy/contacts.rb,
lib/netbox_client_ruby/api/circuits/circuits.rb,
lib/netbox_client_ruby/api/circuits/provider.rb,
lib/netbox_client_ruby/api/dcim/console_port.rb,
lib/netbox_client_ruby/api/dcim/device_roles.rb,
lib/netbox_client_ruby/api/dcim/device_types.rb,
lib/netbox_client_ruby/api/dcim/manufacturer.rb,
lib/netbox_client_ruby/api/dcim/power_outlet.rb,
lib/netbox_client_ruby/api/ipam/ip_addresses.rb,
lib/netbox_client_ruby/api/circuits/providers.rb,
lib/netbox_client_ruby/api/dcim/console_ports.rb,
lib/netbox_client_ruby/api/dcim/mac_addresses.rb,
lib/netbox_client_ruby/api/dcim/manufacturers.rb,
lib/netbox_client_ruby/api/dcim/power_outlets.rb,
lib/netbox_client_ruby/api/dcim/inventory_item.rb,
lib/netbox_client_ruby/api/secrets/secret_role.rb,
lib/netbox_client_ruby/api/secrets/session_key.rb,
lib/netbox_client_ruby/api/dcim/inventory_items.rb,
lib/netbox_client_ruby/api/dcim/virtual_chassis.rb,
lib/netbox_client_ruby/api/extras/journal_entry.rb,
lib/netbox_client_ruby/api/secrets/rsa_key_pair.rb,
lib/netbox_client_ruby/api/secrets/secret_roles.rb,
lib/netbox_client_ruby/api/tenancy/tenant_group.rb,
lib/netbox_client_ruby/api/circuits/circuit_type.rb,
lib/netbox_client_ruby/api/dcim/power_connection.rb,
lib/netbox_client_ruby/api/dcim/rack_reservation.rb,
lib/netbox_client_ruby/api/extras/config_context.rb,
lib/netbox_client_ruby/api/tenancy/contact_group.rb,
lib/netbox_client_ruby/api/tenancy/tenant_groups.rb,
lib/netbox_client_ruby/api/circuits/circuit_types.rb,
lib/netbox_client_ruby/api/dcim/power_connections.rb,
lib/netbox_client_ruby/api/dcim/rack_reservations.rb,
lib/netbox_client_ruby/api/extras/config_contexts.rb,
lib/netbox_client_ruby/api/extras/journal_entries.rb,
lib/netbox_client_ruby/api/tenancy/contact_groups.rb,
lib/netbox_client_ruby/api/virtualization/cluster.rb,
lib/netbox_client_ruby/api/dcim/console_connection.rb,
lib/netbox_client_ruby/api/virtualization/clusters.rb,
lib/netbox_client_ruby/api/dcim/console_connections.rb,
lib/netbox_client_ruby/api/dcim/console_server_port.rb,
lib/netbox_client_ruby/api/virtualization/interface.rb,
lib/netbox_client_ruby/api/dcim/console_server_ports.rb,
lib/netbox_client_ruby/api/dcim/interface_connection.rb,
lib/netbox_client_ruby/api/dcim/virtual_chassis_list.rb,
lib/netbox_client_ruby/api/virtualization/interfaces.rb,
lib/netbox_client_ruby/api/dcim/interface_connections.rb,
lib/netbox_client_ruby/api/virtualization/cluster_type.rb,
lib/netbox_client_ruby/api/circuits/circuit_termination.rb,
lib/netbox_client_ruby/api/virtualization/cluster_group.rb,
lib/netbox_client_ruby/api/virtualization/cluster_types.rb,
lib/netbox_client_ruby/api/circuits/circuit_terminations.rb,
lib/netbox_client_ruby/api/virtualization/cluster_groups.rb,
lib/netbox_client_ruby/api/virtualization/virtual_machine.rb,
lib/netbox_client_ruby/api/virtualization/virtual_machines.rb

Defined Under Namespace

Modules: Circuits, Communication, DCIM, Entities, Entity, Extras, IPAM, Secrets, Tenancy, VERSION, Virtualization Classes: ClientError, Connection, Error, LocalError, RemoteError

Constant Summary collapse

MAX_SIGNED_64BIT_INT = 
9_223_372_036_854_775_807

Class Method Summary collapse

Class Method Details

.circuits ⇒ Object 



81
82
83
 
# File 'lib/netbox_client_ruby.rb', line 81

def self.circuits
  NetboxClientRuby::Circuits
end

.dcim ⇒ Object 



85
86
87
 
# File 'lib/netbox_client_ruby.rb', line 85

def self.dcim
  NetboxClientRuby::DCIM
end

.extras ⇒ Object 



89
90
91
 
# File 'lib/netbox_client_ruby.rb', line 89

def self.extras
  NetboxClientRuby::Extras
end

.gem_version ⇒ Object 



4
5
6
 
# File 'lib/netbox_client_ruby/version.rb', line 4

def self.gem_version
  Gem::Version.new VERSION::STRING
end

.ipam ⇒ Object 



93
94
95
 
# File 'lib/netbox_client_ruby.rb', line 93

def self.ipam
  NetboxClientRuby::IPAM
end

.load_collection(collection, method_name, class_name) ⇒ Object 



71
72
73
74
 
# File 'lib/netbox_client_ruby.rb', line 71

def self.load_collection(collection, method_name, class_name)
  collection.define_method(method_name) { class_name.new }
  collection.__send__(:module_function, method_name)
end

.load_entity(entity, method_name, class_name) ⇒ Object 



76
77
78
79
 
# File 'lib/netbox_client_ruby.rb', line 76

def self.load_entity(entity, method_name, class_name)
  entity.define_method(method_name) { |id| class_name.new id }
  entity.__send__(:module_function, method_name)
end

.secrets ⇒ Object 



97
98
99
 
# File 'lib/netbox_client_ruby.rb', line 97

def self.secrets
  NetboxClientRuby::Secrets
end

.tenancy ⇒ Object 



101
102
103
 
# File 'lib/netbox_client_ruby.rb', line 101

def self.tenancy
  NetboxClientRuby::Tenancy
end

.virtualization ⇒ Object 



105
106
107
 
# File 'lib/netbox_client_ruby.rb', line 105

def self.virtualization
  NetboxClientRuby::Virtualization
end