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.



14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
 
# File 'lib/models/porcelain.rb', line 14790

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.



14756
14757
14758
 
# File 'lib/models/porcelain.rb', line 14756

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.



14758
14759
14760
 
# File 'lib/models/porcelain.rb', line 14758

def bind_interface
  @bind_interface
end

#egress_filter ⇒ Object

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



14760
14761
14762
 
# File 'lib/models/porcelain.rb', line 14760

def egress_filter
  @egress_filter
end

#healthy ⇒ Object

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



14762
14763
14764
 
# File 'lib/models/porcelain.rb', line 14762

def healthy
  @healthy
end

#hostname ⇒ Object

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



14764
14765
14766
 
# File 'lib/models/porcelain.rb', line 14764

def hostname
  @hostname
end

#id ⇒ Object

Unique identifier of the Resource.



14766
14767
14768
 
# File 'lib/models/porcelain.rb', line 14766

def id
  @id
end

#key_type ⇒ Object

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



14768
14769
14770
 
# File 'lib/models/porcelain.rb', line 14768

def key_type
  @key_type
end

#name ⇒ Object

Unique human-readable name of the Resource.



14770
14771
14772
 
# File 'lib/models/porcelain.rb', line 14770

def name
  @name
end

#port ⇒ Object

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



14772
14773
14774
 
# File 'lib/models/porcelain.rb', line 14772

def port
  @port
end

#port_forwarding ⇒ Object

Whether port forwarding is allowed through this server.



14774
14775
14776
 
# File 'lib/models/porcelain.rb', line 14774

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.



14776
14777
14778
 
# File 'lib/models/porcelain.rb', line 14776

def port_override
  @port_override
end

#proxy_cluster_id ⇒ Object

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



14778
14779
14780
 
# File 'lib/models/porcelain.rb', line 14778

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.



14780
14781
14782
 
# File 'lib/models/porcelain.rb', line 14780

def public_key
  @public_key
end

#secret_store_id ⇒ Object

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



14782
14783
14784
 
# File 'lib/models/porcelain.rb', line 14782

def secret_store_id
  @secret_store_id
end

#subdomain ⇒ Object

DNS subdomain through which this resource may be accessed on clients. (e.g. "app-prod1" allows the resource to be accessed at "app-prod1.your-org-name.sdm-proxy-domain"). Only applicable to HTTP-based resources or resources using virtual networking mode.



14784
14785
14786
 
# File 'lib/models/porcelain.rb', line 14784

def subdomain
  @subdomain
end

#tags ⇒ Object

Tags is a map of key, value pairs.



14786
14787
14788
 
# File 'lib/models/porcelain.rb', line 14786

def tags
  @tags
end

#username ⇒ Object

The username to authenticate with.



14788
14789
14790
 
# File 'lib/models/porcelain.rb', line 14788

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object 



14828
14829
14830
14831
14832
14833
14834
 
# File 'lib/models/porcelain.rb', line 14828

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