Class: SDM::Gateway

Inherits:
Object
  • Object
show all
Defined in:
lib/models/porcelain.rb

Overview

Gateway represents a StrongDM CLI installation running in gateway mode.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(bind_address: nil, device: nil, gateway_filter: nil, id: nil, listen_address: nil, location: nil, name: nil, state: nil, tags: nil, version: nil) ⇒ Gateway

Returns a new instance of Gateway.



3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
 
# File 'lib/models/porcelain.rb', line 3514

def initialize(
  bind_address: nil,
  device: nil,
  gateway_filter: nil,
  id: nil,
  listen_address: nil,
  location: nil,
  name: nil,
  state: nil,
  tags: nil,
  version: nil
)
  @bind_address = bind_address == nil ? "" : bind_address
  @device = device == nil ? "" : device
  @gateway_filter = gateway_filter == nil ? "" : gateway_filter
  @id = id == nil ? "" : id
  @listen_address = listen_address == nil ? "" : listen_address
  @location = location == nil ? "" : location
  @name = name == nil ? "" : name
  @state = state == nil ? "" : state
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @version = version == nil ? "" : version
end

Instance Attribute Details

#bind_address ⇒ Object

The hostname/port tuple which the gateway daemon will bind to. If not provided on create, set to "0.0.0.0:listen_address_port".



3489
3490
3491
 
# File 'lib/models/porcelain.rb', line 3489

def bind_address
  @bind_address
end

#device ⇒ Object

Device is a read only device name uploaded by the gateway process when it comes online.



3492
3493
3494
 
# File 'lib/models/porcelain.rb', line 3492

def device
  @device
end

#gateway_filter ⇒ Object

GatewayFilter can be used to restrict the peering between relays and gateways.



3495
3496
3497
 
# File 'lib/models/porcelain.rb', line 3495

def gateway_filter
  @gateway_filter
end

#id ⇒ Object

Unique identifier of the Gateway.



3497
3498
3499
 
# File 'lib/models/porcelain.rb', line 3497

def id
  @id
end

#listen_address ⇒ Object

The public hostname/port tuple at which the gateway will be accessible to clients.



3499
3500
3501
 
# File 'lib/models/porcelain.rb', line 3499

def listen_address
  @listen_address
end

#location ⇒ Object

Location is a read only network location uploaded by the gateway process when it comes online.



3502
3503
3504
 
# File 'lib/models/porcelain.rb', line 3502

def location
  @location
end

#name ⇒ Object

Unique human-readable name of the Gateway. Node names must include only letters, numbers, and hyphens (no spaces, underscores, or other special characters). Generated if not provided on create.



3504
3505
3506
 
# File 'lib/models/porcelain.rb', line 3504

def name
  @name
end

#state ⇒ Object

The current state of the gateway. One of: "new", "verifying_restart", "restarting", "started", "stopped", "dead", "unknown"



3507
3508
3509
 
# File 'lib/models/porcelain.rb', line 3507

def state
  @state
end

#tags ⇒ Object

Tags is a map of key, value pairs.



3509
3510
3511
 
# File 'lib/models/porcelain.rb', line 3509

def tags
  @tags
end

#version ⇒ Object

Version is a read only sdm binary version uploaded by the gateway process when it comes online.



3512
3513
3514
 
# File 'lib/models/porcelain.rb', line 3512

def version
  @version
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



3538
3539
3540
3541
3542
3543
3544
 
# File 'lib/models/porcelain.rb', line 3538

def to_json(options = {})
  hash = {}
  self.instance_variables.each do |var|
    hash[var.id2name.delete_prefix("@")] = self.instance_variable_get var
  end
  hash.to_json
end