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, proxy_cluster_id: nil, public_key: nil, secret_store_id: nil, subdomain: nil, tags: nil, username: nil) ⇒ SSH

Returns a new instance of SSH.



13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
 
# File 'lib/models/porcelain.rb', line 13684

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,
  proxy_cluster_id: 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
  @proxy_cluster_id = proxy_cluster_id == nil ? "" : proxy_cluster_id
  @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.



13650
13651
13652
 
# File 'lib/models/porcelain.rb', line 13650

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 and may also be set to one of the ResourceIPAllocationMode constants to select between VNM, loopback, or default allocation.



13652
13653
13654
 
# File 'lib/models/porcelain.rb', line 13652

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



13654
13655
13656
 
# File 'lib/models/porcelain.rb', line 13654

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



13656
13657
13658
 
# File 'lib/models/porcelain.rb', line 13656

def healthy
  @healthy
end

#hostname ⇒ Object

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



13658
13659
13660
 
# File 'lib/models/porcelain.rb', line 13658

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



13660
13661
13662
 
# File 'lib/models/porcelain.rb', line 13660

def id
  @id
end

#key_type ⇒ Object

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



13662
13663
13664
 
# File 'lib/models/porcelain.rb', line 13662

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



13664
13665
13666
 
# File 'lib/models/porcelain.rb', line 13664

def name
  @name
end

#port ⇒ Object

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



13666
13667
13668
 
# File 'lib/models/porcelain.rb', line 13666

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



13668
13669
13670
 
# File 'lib/models/porcelain.rb', line 13668

def port_forwarding
  @port_forwarding
end

#port_override ⇒ Object

The local port used by clients to connect to this resource. It is automatically generated if not provided on create and may be re-generated on update by specifying a value of -1.



13670
13671
13672
 
# File 'lib/models/porcelain.rb', line 13670

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

ID of the proxy cluster for this resource, if any.



13672
13673
13674
 
# File 'lib/models/porcelain.rb', line 13672

def proxy_cluster_id
  @proxy_cluster_id
end

#public_key ⇒ Object

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



13674
13675
13676
 
# File 'lib/models/porcelain.rb', line 13674

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



13676
13677
13678
 
# File 'lib/models/porcelain.rb', line 13676

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)



13678
13679
13680
 
# File 'lib/models/porcelain.rb', line 13678

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



13680
13681
13682
 
# File 'lib/models/porcelain.rb', line 13680

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



13682
13683
13684
 
# File 'lib/models/porcelain.rb', line 13682

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



13722
13723
13724
13725
13726
13727
13728
 
# File 'lib/models/porcelain.rb', line 13722

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