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.



8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
 
# File 'lib/models/porcelain.rb', line 8721

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.



8689
8690
8691
 
# File 'lib/models/porcelain.rb', line 8689

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.



8691
8692
8693
 
# File 'lib/models/porcelain.rb', line 8691

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



8693
8694
8695
 
# File 'lib/models/porcelain.rb', line 8693

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



8695
8696
8697
 
# File 'lib/models/porcelain.rb', line 8695

def healthy
  @healthy
end

#hostname ⇒ Object

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



8697
8698
8699
 
# File 'lib/models/porcelain.rb', line 8697

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



8699
8700
8701
 
# File 'lib/models/porcelain.rb', line 8699

def id
  @id
end

#key_type ⇒ Object

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



8701
8702
8703
 
# File 'lib/models/porcelain.rb', line 8701

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



8703
8704
8705
 
# File 'lib/models/porcelain.rb', line 8703

def name
  @name
end

#port ⇒ Object

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



8705
8706
8707
 
# File 'lib/models/porcelain.rb', line 8705

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



8707
8708
8709
 
# File 'lib/models/porcelain.rb', line 8707

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

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



8709
8710
8711
 
# File 'lib/models/porcelain.rb', line 8709

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.



8711
8712
8713
 
# File 'lib/models/porcelain.rb', line 8711

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



8713
8714
8715
 
# File 'lib/models/porcelain.rb', line 8713

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)



8715
8716
8717
 
# File 'lib/models/porcelain.rb', line 8715

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



8717
8718
8719
 
# File 'lib/models/porcelain.rb', line 8717

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



8719
8720
8721
 
# File 'lib/models/porcelain.rb', line 8719

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



8757
8758
8759
8760
8761
8762
8763
 
# File 'lib/models/porcelain.rb', line 8757

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