Class: SDM::SQLServerKerberosAD

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(allow_deprecated_encryption: nil, bind_interface: nil, database: nil, egress_filter: nil, healthy: nil, hostname: nil, id: nil, keytab: nil, krb_config: nil, name: nil, override_database: nil, port: nil, port_override: nil, realm: nil, schema: nil, secret_store_id: nil, server_spn: nil, subdomain: nil, tags: nil, username: nil) ⇒ SQLServerKerberosAD

Returns a new instance of SQLServerKerberosAD.



9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
# File 'lib/models/porcelain.rb', line 9908

def initialize(
  allow_deprecated_encryption: nil,
  bind_interface: nil,
  database: nil,
  egress_filter: nil,
  healthy: nil,
  hostname: nil,
  id: nil,
  keytab: nil,
  krb_config: nil,
  name: nil,
  override_database: nil,
  port: nil,
  port_override: nil,
  realm: nil,
  schema: nil,
  secret_store_id: nil,
  server_spn: nil,
  subdomain: nil,
  tags: nil,
  username: nil
)
  @allow_deprecated_encryption = allow_deprecated_encryption == nil ? false : allow_deprecated_encryption
  @bind_interface = bind_interface == nil ? "" : bind_interface
  @database = database == nil ? "" : database
  @egress_filter = egress_filter == nil ? "" : egress_filter
  @healthy = healthy == nil ? false : healthy
  @hostname = hostname == nil ? "" : hostname
  @id = id == nil ? "" : id
  @keytab = keytab == nil ? "" : keytab
  @krb_config = krb_config == nil ? "" : krb_config
  @name = name == nil ? "" : name
  @override_database = override_database == nil ? false : override_database
  @port = port == nil ? 0 : port
  @port_override = port_override == nil ? 0 : port_override
  @realm = realm == nil ? "" : realm
  @schema = schema == nil ? "" : schema
  @secret_store_id = secret_store_id == nil ? "" : secret_store_id
  @server_spn = server_spn == nil ? "" : server_spn
  @subdomain = subdomain == nil ? "" : subdomain
  @tags = tags == nil ? SDM::_porcelain_zero_value_tags() : tags
  @username = username == nil ? "" : username
end

Instance Attribute Details

#allow_deprecated_encryptionObject

Whether to allow deprecated encryption protocols to be used for this resource. For example, TLS 1.0.



9868
9869
9870
# File 'lib/models/porcelain.rb', line 9868

def allow_deprecated_encryption
  @allow_deprecated_encryption
end

#bind_interfaceObject

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.



9870
9871
9872
# File 'lib/models/porcelain.rb', line 9870

def bind_interface
  @bind_interface
end

#databaseObject

The database for healthchecks, and used for clients if Override Default Database is true.



9872
9873
9874
# File 'lib/models/porcelain.rb', line 9872

def database
  @database
end

#egress_filterObject

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



9874
9875
9876
# File 'lib/models/porcelain.rb', line 9874

def egress_filter
  @egress_filter
end

#healthyObject

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



9876
9877
9878
# File 'lib/models/porcelain.rb', line 9876

def healthy
  @healthy
end

#hostnameObject

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



9878
9879
9880
# File 'lib/models/porcelain.rb', line 9878

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



9880
9881
9882
# File 'lib/models/porcelain.rb', line 9880

def id
  @id
end

#keytabObject

The keytab file in base64 format containing an entry with the principal name (username@realm) and key version number with which to authenticate.



9882
9883
9884
# File 'lib/models/porcelain.rb', line 9882

def keytab
  @keytab
end

#krb_configObject

The Kerberos 5 configuration file (krb5.conf) specifying the Active Directory server (KDC) for the configured realm.



9884
9885
9886
# File 'lib/models/porcelain.rb', line 9884

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



9886
9887
9888
# File 'lib/models/porcelain.rb', line 9886

def name
  @name
end

#override_databaseObject

If set, the database configured cannot be changed by users. This setting is not recommended for most use cases, as some clients will insist their database has changed when it has not, leading to user confusion.



9888
9889
9890
# File 'lib/models/porcelain.rb', line 9888

def override_database
  @override_database
end

#portObject

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



9890
9891
9892
# File 'lib/models/porcelain.rb', line 9890

def port
  @port
end

#port_overrideObject

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



9892
9893
9894
# File 'lib/models/porcelain.rb', line 9892

def port_override
  @port_override
end

#realmObject

The Active Directory domain (realm) to which the configured username belongs.



9894
9895
9896
# File 'lib/models/porcelain.rb', line 9894

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



9896
9897
9898
# File 'lib/models/porcelain.rb', line 9896

def schema
  @schema
end

#secret_store_idObject

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



9898
9899
9900
# File 'lib/models/porcelain.rb', line 9898

def secret_store_id
  @secret_store_id
end

#server_spnObject

The Service Principal Name of the Microsoft SQL Server instance in Active Directory.



9900
9901
9902
# File 'lib/models/porcelain.rb', line 9900

def server_spn
  @server_spn
end

#subdomainObject

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



9902
9903
9904
# File 'lib/models/porcelain.rb', line 9902

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



9904
9905
9906
# File 'lib/models/porcelain.rb', line 9904

def tags
  @tags
end

#usernameObject

The username to authenticate with.



9906
9907
9908
# File 'lib/models/porcelain.rb', line 9906

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



9952
9953
9954
9955
9956
9957
9958
# File 'lib/models/porcelain.rb', line 9952

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