Class: SDM::SSH

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allow_deprecated_key_exchanges: nil, bind_interface: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, key_type: nil, name: nil, port: nil, port_forwarding: nil, port_override: nil, public_key: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSH

Returns a new instance of SSH.



9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
 
# File 'lib/models/porcelain.rb', line 9592

def initialize(
  allow_deprecated_key_exchanges: nil,
  bind_interface: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  key_type: nil,
  name: nil,
  port: nil,
  port_forwarding: nil,
  port_override: nil,
  public_key: nil,
  secret_store_id: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @allow_deprecated_key_exchanges = allow_deprecated_key_exchanges == nil ? false : allow_deprecated_key_exchanges
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @key_type = key_type == nil ? "" : key_type
  @name = name == nil ? "" : name
  @port = port == nil ? 0 : port
  @port_forwarding = port_forwarding == nil ? false : port_forwarding
  @port_override = port_override == nil ? 0 : port_override
  @public_key = public_key == nil ? "" : public_key
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#allow_deprecated_key_exchanges ⇒ Object

Whether deprecated, insecure key exchanges are allowed for use to connect to the target ssh server.



9560
9561
9562
 
# File 'lib/models/porcelain.rb', line 9560

def allow_deprecated_key_exchanges
  @allow_deprecated_key_exchanges
end

#bind_interface ⇒ Object

The bind interface is the IP address to which the port override of a resource is bound (for example, 127.0.0.1). It is automatically generated if not provided.



9562
9563
9564
 
# File 'lib/models/porcelain.rb', line 9562

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

A filter applied to the routing logic to pin datasource to nodes.



9564
9565
9566
 
# File 'lib/models/porcelain.rb', line 9564

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

True if the datasource is reachable and the credentials are valid.



9566
9567
9568
 
# File 'lib/models/porcelain.rb', line 9566

def healthy
  @healthy
end

#hostname ⇒ Object

The host to dial to initiate a connection from the egress node to this resource.



9568
9569
9570
 
# File 'lib/models/porcelain.rb', line 9568

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



9570
9571
9572
 
# File 'lib/models/porcelain.rb', line 9570

def id
  @id
end

#key_type ⇒ Object

The key type to use e.g. rsa-2048 or ed25519



9572
9573
9574
 
# File 'lib/models/porcelain.rb', line 9572

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



9574
9575
9576
 
# File 'lib/models/porcelain.rb', line 9574

def name
  @name
end

#port ⇒ Object

The port to dial to initiate a connection from the egress node to this resource.



9576
9577
9578
 
# File 'lib/models/porcelain.rb', line 9576

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



9578
9579
9580
 
# File 'lib/models/porcelain.rb', line 9578

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

The local port used by clients to connect to this resource.



9580
9581
9582
 
# File 'lib/models/porcelain.rb', line 9580

def port_override
  @port_override
end

#public_key ⇒ Object

The public key to append to a server's authorized keys. This will be generated after resource creation.



9582
9583
9584
 
# File 'lib/models/porcelain.rb', line 9582

def public_key
  @public_key
end

#secret_store_id ⇒ Object

ID of the secret store containing credentials for this resource, if any.



9584
9585
9586
 
# File 'lib/models/porcelain.rb', line 9584

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

Subdomain is the local DNS address. (e.g. app-prod1 turns into app-prod1.your-org-name.sdm.network)



9586
9587
9588
 
# File 'lib/models/porcelain.rb', line 9586

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



9588
9589
9590
 
# File 'lib/models/porcelain.rb', line 9588

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



9590
9591
9592
 
# File 'lib/models/porcelain.rb', line 9590

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



9628
9629
9630
9631
9632
9633
9634
 
# File 'lib/models/porcelain.rb', line 9628

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