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.



9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
# File 'lib/models/porcelain.rb', line 9975

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.



9935
9936
9937
# File 'lib/models/porcelain.rb', line 9935

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.



9937
9938
9939
# File 'lib/models/porcelain.rb', line 9937

def bind_interface
  @bind_interface
end

#databaseObject

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



9939
9940
9941
# File 'lib/models/porcelain.rb', line 9939

def database
  @database
end

#egress_filterObject

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



9941
9942
9943
# File 'lib/models/porcelain.rb', line 9941

def egress_filter
  @egress_filter
end

#healthyObject

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



9943
9944
9945
# File 'lib/models/porcelain.rb', line 9943

def healthy
  @healthy
end

#hostnameObject

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



9945
9946
9947
# File 'lib/models/porcelain.rb', line 9945

def hostname
  @hostname
end

#idObject

Unique identifier of the Resource.



9947
9948
9949
# File 'lib/models/porcelain.rb', line 9947

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.



9949
9950
9951
# File 'lib/models/porcelain.rb', line 9949

def keytab
  @keytab
end

#krb_configObject

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



9951
9952
9953
# File 'lib/models/porcelain.rb', line 9951

def krb_config
  @krb_config
end

#nameObject

Unique human-readable name of the Resource.



9953
9954
9955
# File 'lib/models/porcelain.rb', line 9953

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.



9955
9956
9957
# File 'lib/models/porcelain.rb', line 9955

def override_database
  @override_database
end

#portObject

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



9957
9958
9959
# File 'lib/models/porcelain.rb', line 9957

def port
  @port
end

#port_overrideObject

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



9959
9960
9961
# File 'lib/models/porcelain.rb', line 9959

def port_override
  @port_override
end

#realmObject

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



9961
9962
9963
# File 'lib/models/porcelain.rb', line 9961

def realm
  @realm
end

#schemaObject

The Schema to use to direct initial requests.



9963
9964
9965
# File 'lib/models/porcelain.rb', line 9963

def schema
  @schema
end

#secret_store_idObject

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



9965
9966
9967
# File 'lib/models/porcelain.rb', line 9965

def secret_store_id
  @secret_store_id
end

#server_spnObject

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



9967
9968
9969
# File 'lib/models/porcelain.rb', line 9967

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)



9969
9970
9971
# File 'lib/models/porcelain.rb', line 9969

def subdomain
  @subdomain
end

#tagsObject

Tags is a map of key, value pairs.



9971
9972
9973
# File 'lib/models/porcelain.rb', line 9971

def tags
  @tags
end

#usernameObject

The username to authenticate with.



9973
9974
9975
# File 'lib/models/porcelain.rb', line 9973

def username
  @username
end

Instance Method Details

#to_json(options = {}) ⇒ Object



10019
10020
10021
10022
10023
10024
10025
# File 'lib/models/porcelain.rb', line 10019

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