Class: Akeyless::GatewayCreateMigration

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

Overview

gatewayCreateMigration is a command that create migration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GatewayCreateMigration

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 359

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Akeyless::GatewayCreateMigration` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Akeyless::GatewayCreateMigration`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'_1password_email')
    self._1password_email = attributes[:'_1password_email']
  end

  if attributes.key?(:'_1password_password')
    self._1password_password = attributes[:'_1password_password']
  end

  if attributes.key?(:'_1password_secret_key')
    self._1password_secret_key = attributes[:'_1password_secret_key']
  end

  if attributes.key?(:'_1password_url')
    self._1password_url = attributes[:'_1password_url']
  end

  if attributes.key?(:'_1password_vaults')
    if (value = attributes[:'_1password_vaults']).is_a?(Array)
      self._1password_vaults = value
    end
  end

  if attributes.key?(:'ad_discover_services')
    self.ad_discover_services = attributes[:'ad_discover_services']
  else
    self.ad_discover_services = 'false'
  end

  if attributes.key?(:'ad_discovery_types')
    if (value = attributes[:'ad_discovery_types']).is_a?(Array)
      self.ad_discovery_types = value
    end
  end

  if attributes.key?(:'ad_os_filter')
    self.ad_os_filter = attributes[:'ad_os_filter']
  end

  if attributes.key?(:'ad_ssh_port')
    self.ad_ssh_port = attributes[:'ad_ssh_port']
  else
    self.ad_ssh_port = '22'
  end

  if attributes.key?(:'ad_target_format')
    self.ad_target_format = attributes[:'ad_target_format']
  else
    self.ad_target_format = 'linked'
  end

  if attributes.key?(:'ad_targets_type')
    self.ad_targets_type = attributes[:'ad_targets_type']
  else
    self.ad_targets_type = 'windows'
  end

  if attributes.key?(:'ad_winrm_over_http')
    self.ad_winrm_over_http = attributes[:'ad_winrm_over_http']
  else
    self.ad_winrm_over_http = 'false'
  end

  if attributes.key?(:'ad_winrm_port')
    self.ad_winrm_port = attributes[:'ad_winrm_port']
  else
    self.ad_winrm_port = '5986'
  end

  if attributes.key?(:'ad_auto_rotate')
    self.ad_auto_rotate = attributes[:'ad_auto_rotate']
  end

  if attributes.key?(:'ad_computer_base_dn')
    self.ad_computer_base_dn = attributes[:'ad_computer_base_dn']
  end

  if attributes.key?(:'ad_discover_local_users')
    self.ad_discover_local_users = attributes[:'ad_discover_local_users']
  end

  if attributes.key?(:'ad_domain_name')
    self.ad_domain_name = attributes[:'ad_domain_name']
  end

  if attributes.key?(:'ad_domain_users_path_template')
    self.ad_domain_users_path_template = attributes[:'ad_domain_users_path_template']
  end

  if attributes.key?(:'ad_local_users_ignore')
    self.ad_local_users_ignore = attributes[:'ad_local_users_ignore']
  end

  if attributes.key?(:'ad_local_users_path_template')
    self.ad_local_users_path_template = attributes[:'ad_local_users_path_template']
  end

  if attributes.key?(:'ad_rotation_hour')
    self.ad_rotation_hour = attributes[:'ad_rotation_hour']
  end

  if attributes.key?(:'ad_rotation_interval')
    self.ad_rotation_interval = attributes[:'ad_rotation_interval']
  end

  if attributes.key?(:'ad_sra_enable_rdp')
    self.ad_sra_enable_rdp = attributes[:'ad_sra_enable_rdp']
  end

  if attributes.key?(:'ad_target_name')
    self.ad_target_name = attributes[:'ad_target_name']
  end

  if attributes.key?(:'ad_targets_path_template')
    self.ad_targets_path_template = attributes[:'ad_targets_path_template']
  end

  if attributes.key?(:'ad_user_base_dn')
    self.ad_user_base_dn = attributes[:'ad_user_base_dn']
  end

  if attributes.key?(:'ad_user_groups')
    self.ad_user_groups = attributes[:'ad_user_groups']
  end

  if attributes.key?(:'aws_key')
    self.aws_key = attributes[:'aws_key']
  end

  if attributes.key?(:'aws_key_id')
    self.aws_key_id = attributes[:'aws_key_id']
  end

  if attributes.key?(:'aws_region')
    self.aws_region = attributes[:'aws_region']
  else
    self.aws_region = 'us-east-2'
  end

  if attributes.key?(:'azure_client_id')
    self.azure_client_id = attributes[:'azure_client_id']
  end

  if attributes.key?(:'azure_kv_name')
    self.azure_kv_name = attributes[:'azure_kv_name']
  end

  if attributes.key?(:'azure_secret')
    self.azure_secret = attributes[:'azure_secret']
  end

  if attributes.key?(:'azure_tenant_id')
    self.azure_tenant_id = attributes[:'azure_tenant_id']
  end

  if attributes.key?(:'gcp_key')
    self.gcp_key = attributes[:'gcp_key']
  end

  if attributes.key?(:'hashi_json')
    self.hashi_json = attributes[:'hashi_json']
  else
    self.hashi_json = 'true'
  end

  if attributes.key?(:'hashi_ns')
    if (value = attributes[:'hashi_ns']).is_a?(Array)
      self.hashi_ns = value
    end
  end

  if attributes.key?(:'hashi_token')
    self.hashi_token = attributes[:'hashi_token']
  end

  if attributes.key?(:'hashi_url')
    self.hashi_url = attributes[:'hashi_url']
  end

  if attributes.key?(:'json')
    self.json = attributes[:'json']
  else
    self.json = false
  end

  if attributes.key?(:'k8s_ca_certificate')
    if (value = attributes[:'k8s_ca_certificate']).is_a?(Array)
      self.k8s_ca_certificate = value
    end
  end

  if attributes.key?(:'k8s_client_certificate')
    if (value = attributes[:'k8s_client_certificate']).is_a?(Array)
      self.k8s_client_certificate = value
    end
  end

  if attributes.key?(:'k8s_client_key')
    if (value = attributes[:'k8s_client_key']).is_a?(Array)
      self.k8s_client_key = value
    end
  end

  if attributes.key?(:'k8s_namespace')
    self.k8s_namespace = attributes[:'k8s_namespace']
  end

  if attributes.key?(:'k8s_password')
    self.k8s_password = attributes[:'k8s_password']
  end

  if attributes.key?(:'k8s_skip_system')
    self.k8s_skip_system = attributes[:'k8s_skip_system']
  end

  if attributes.key?(:'k8s_token')
    self.k8s_token = attributes[:'k8s_token']
  end

  if attributes.key?(:'k8s_url')
    self.k8s_url = attributes[:'k8s_url']
  end

  if attributes.key?(:'k8s_username')
    self.k8s_username = attributes[:'k8s_username']
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'protection_key')
    self.protection_key = attributes[:'protection_key']
  end

  if attributes.key?(:'si_auto_rotate')
    self.si_auto_rotate = attributes[:'si_auto_rotate']
  end

  if attributes.key?(:'si_rotation_hour')
    self.si_rotation_hour = attributes[:'si_rotation_hour']
  end

  if attributes.key?(:'si_rotation_interval')
    self.si_rotation_interval = attributes[:'si_rotation_interval']
  end

  if attributes.key?(:'si_sra_enable_rdp')
    self.si_sra_enable_rdp = attributes[:'si_sra_enable_rdp']
  else
    self.si_sra_enable_rdp = 'false'
  end

  if attributes.key?(:'si_target_name')
    self.si_target_name = attributes[:'si_target_name']
  else
    self.si_target_name = nil
  end

  if attributes.key?(:'si_user_groups')
    self.si_user_groups = attributes[:'si_user_groups']
  end

  if attributes.key?(:'si_users_ignore')
    self.si_users_ignore = attributes[:'si_users_ignore']
  end

  if attributes.key?(:'si_users_path_template')
    self.si_users_path_template = attributes[:'si_users_path_template']
  else
    self.si_users_path_template = nil
  end

  if attributes.key?(:'target_location')
    self.target_location = attributes[:'target_location']
  else
    self.target_location = nil
  end

  if attributes.key?(:'token')
    self.token = attributes[:'token']
  end

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.key?(:'uid_token')
    self.uid_token = attributes[:'uid_token']
  end
end

Instance Attribute Details

#_1password_email ⇒ Object

1Password user email to connect to the API



20
21
22
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 20

def _1password_email
  @_1password_email
end

#_1password_password ⇒ Object

1Password user password to connect to the API



23
24
25
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 23

def _1password_password
  @_1password_password
end

#_1password_secret_key ⇒ Object

1Password user secret key to connect to the API



26
27
28
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 26

def _1password_secret_key
  @_1password_secret_key
end

#_1password_url ⇒ Object

1Password api container url



29
30
31
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 29

def _1password_url
  @_1password_url
end

#_1password_vaults ⇒ Object

1Password list of vault to get the items from



32
33
34
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 32

def _1password_vaults
  @_1password_vaults
end

#ad_auto_rotate ⇒ Object

Enable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with –ad-rotation-interval and –ad-rotation-hour parameters (Relevant only for Active Directory migration)



59
60
61
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 59

def ad_auto_rotate
  @ad_auto_rotate
end

#ad_computer_base_dn ⇒ Object

Distinguished Name of Computer objects (servers) to search in Active Directory e.g.: CN=Computers,DC=example,DC=com (Relevant only for Active Directory migration)



62
63
64
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 62

def ad_computer_base_dn
  @ad_computer_base_dn
end

#ad_discover_local_users ⇒ Object

Enable/Disable discovery of local users from each domain server and migrate them as SSH/Windows Rotated Secrets. Default is false: only domain users will be migrated. Discovery of local users might require further installation of SSH on the servers, based on the supplied computer base DN. This will be implemented automatically as part of the migration process (Relevant only for Active Directory migration) Deprecated: use AdDiscoverTypes



65
66
67
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 65

def ad_discover_local_users
  @ad_discover_local_users
end

#ad_discover_services ⇒ Object

Enable/Disable discovery of Windows services from each domain server as part of the SSH/Windows Rotated Secrets. Default is false. (Relevant only for Active Directory migration)



35
36
37
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 35

def ad_discover_services
  @ad_discover_services
end

#ad_discovery_types ⇒ Object

Set migration discovery types (domain-users, computers, local-users). (Relevant only for Active Directory migration)



38
39
40
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 38

def ad_discovery_types
  @ad_discovery_types
end

#ad_domain_name ⇒ Object

Active Directory Domain Name (Relevant only for Active Directory migration)



68
69
70
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 68

def ad_domain_name
  @ad_domain_name
end

#ad_domain_users_path_template ⇒ Object

Path location template for migrating domain users as Rotated Secrets e.g.: …/DomainUsers/{USERNAME} (Relevant only for Active Directory migration)



71
72
73
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 71

def ad_domain_users_path_template
  @ad_domain_users_path_template
end

#ad_local_users_ignore ⇒ Object

Comma-separated list of Local Users which should not be migrated (Relevant only for Active Directory migration)



74
75
76
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 74

def ad_local_users_ignore
  @ad_local_users_ignore
end

#ad_local_users_path_template ⇒ Object

Path location template for migrating domain users as Rotated Secrets e.g.: …/LocalUsers/{COMPUTER_NAME}/{USERNAME} (Relevant only for Active Directory migration)



77
78
79
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 77

def ad_local_users_path_template
  @ad_local_users_path_template
end

#ad_os_filter ⇒ Object

Filter by Operating System to run the migration, can be used with wildcards, e.g. SRV20* (Relevant only for Active Directory migration)



41
42
43
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 41

def ad_os_filter
  @ad_os_filter
end

#ad_rotation_hour ⇒ Object

The hour of the scheduled rotation in UTC (Relevant only for Active Directory migration)



80
81
82
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 80

def ad_rotation_hour
  @ad_rotation_hour
end

#ad_rotation_interval ⇒ Object

The number of days to wait between every automatic rotation [1-365] (Relevant only for Active Directory migration)



83
84
85
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 83

def ad_rotation_interval
  @ad_rotation_interval
end

#ad_sra_enable_rdp ⇒ Object

Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets. Default is false: rotated secrets will not be created with SRA (Relevant only for Active Directory migration)



86
87
88
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 86

def ad_sra_enable_rdp
  @ad_sra_enable_rdp
end

#ad_ssh_port ⇒ Object

Set the SSH Port for further connection to the domain servers. Default is port 22 (Relevant only for Active Directory migration)



44
45
46
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 44

def ad_ssh_port
  @ad_ssh_port
end

#ad_target_format ⇒ Object

Relevant only for ad-discovery-types=computers. For linked, all computers will be migrated into a linked target(s). if set with regular, the migration will create a target for each computer.



47
48
49
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 47

def ad_target_format
  @ad_target_format
end

#ad_target_name ⇒ Object

Active Directory LDAP Target Name. Server type should be Active Directory (Relevant only for Active Directory migration)



89
90
91
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 89

def ad_target_name
  @ad_target_name
end

#ad_targets_path_template ⇒ Object

Path location template for migrating domain servers as SSH/Windows Targets e.g.: …/Servers/{COMPUTER_NAME} (Relevant only for Active Directory migration)



92
93
94
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 92

def ad_targets_path_template
  @ad_targets_path_template
end

#ad_targets_type ⇒ Object

Set the target type of the domain servers [ssh/windows](Relevant only for Active Directory migration)



50
51
52
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 50

def ad_targets_type
  @ad_targets_type
end

#ad_user_base_dn ⇒ Object

Distinguished Name of User objects to search in Active Directory, e.g.: CN=Users,DC=example,DC=com (Relevant only for Active Directory migration)



95
96
97
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 95

def ad_user_base_dn
  @ad_user_base_dn
end

#ad_user_groups ⇒ Object

Comma-separated list of domain groups from which privileged domain users will be migrated. If empty, migrate all users based on the –ad-user-base-dn (Relevant only for Active Directory migration)



98
99
100
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 98

def ad_user_groups
  @ad_user_groups
end

#ad_winrm_over_http ⇒ Object

Use WinRM over HTTP, by default runs over HTTPS



53
54
55
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 53

def ad_winrm_over_http
  @ad_winrm_over_http
end

#ad_winrm_port ⇒ Object

Set the WinRM Port for further connection to the domain servers. Default is 5986 (Relevant only for Active Directory migration)



56
57
58
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 56

def ad_winrm_port
  @ad_winrm_port
end

#aws_key ⇒ Object

AWS Secret Access Key (relevant only for AWS migration)



101
102
103
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 101

def aws_key
  @aws_key
end

#aws_key_id ⇒ Object

AWS Access Key ID with sufficient permissions to get all secrets, e.g. ‘arn:aws:secretsmanager::[AccountId]:secret:’ (relevant only for AWS migration)



104
105
106
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 104

def aws_key_id
  @aws_key_id
end

#aws_region ⇒ Object

AWS region of the required Secrets Manager (relevant only for AWS migration)



107
108
109
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 107

def aws_region
  @aws_region
end

#azure_client_id ⇒ Object

Azure Key Vault Access client ID, should be Azure AD App with a service principal (relevant only for Azure Key Vault migration)



110
111
112
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 110

def azure_client_id
  @azure_client_id
end

#azure_kv_name ⇒ Object

Azure Key Vault Name (relevant only for Azure Key Vault migration)



113
114
115
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 113

def azure_kv_name
  @azure_kv_name
end

#azure_secret ⇒ Object

Azure Key Vault secret (relevant only for Azure Key Vault migration)



116
117
118
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 116

def azure_secret
  @azure_secret
end

#azure_tenant_id ⇒ Object

Azure Key Vault Access tenant ID (relevant only for Azure Key Vault migration)



119
120
121
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 119

def azure_tenant_id
  @azure_tenant_id
end

#gcp_key ⇒ Object

Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. ‘roles/secretmanager.secretAccessor’ (relevant only for GCP migration)



122
123
124
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 122

def gcp_key
  @gcp_key
end

#hashi_json ⇒ Object

Import secret key as json value or independent secrets (relevant only for HasiCorp Vault migration) [true/false]



125
126
127
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 125

def hashi_json
  @hashi_json
end

#hashi_ns ⇒ Object

HashiCorp Vault Namespaces is a comma-separated list of namespaces which need to be imported into Akeyless Vault. For every provided namespace, all its child namespaces are imported as well, e.g. nmsp/subnmsp1/subnmsp2,nmsp/anothernmsp. By default, import all namespaces (relevant only for HasiCorp Vault migration)



128
129
130
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 128

def hashi_ns
  @hashi_ns
end

#hashi_token ⇒ Object

HashiCorp Vault access token with sufficient permissions to preform list & read operations on secrets objects (relevant only for HasiCorp Vault migration)



131
132
133
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 131

def hashi_token
  @hashi_token
end

#hashi_url ⇒ Object

HashiCorp Vault API URL, e.g. vault-mgr01:8200 (relevant only for HasiCorp Vault migration)



134
135
136
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 134

def hashi_url
  @hashi_url
end

#json ⇒ Object

Set output format to JSON



137
138
139
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 137

def json
  @json
end

#k8s_ca_certificate ⇒ Object

For Certificate Authentication method K8s Cluster CA certificate (relevant only for K8s migration with Certificate Authentication method)



140
141
142
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 140

def k8s_ca_certificate
  @k8s_ca_certificate
end

#k8s_client_certificate ⇒ Object

K8s Client certificate with sufficient permission to list and get secrets in the namespace(s) you selected (relevant only for K8s migration with Certificate Authentication method)



143
144
145
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 143

def k8s_client_certificate
  @k8s_client_certificate
end

#k8s_client_key ⇒ Object

K8s Client key (relevant only for K8s migration with Certificate Authentication method)



146
147
148
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 146

def k8s_client_key
  @k8s_client_key
end

#k8s_namespace ⇒ Object

K8s Namespace, Use this field to import secrets from a particular namespace only. By default, the secrets are imported from all namespaces (relevant only for K8s migration)



149
150
151
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 149

def k8s_namespace
  @k8s_namespace
end

#k8s_password ⇒ Object

K8s Client password (relevant only for K8s migration with Password Authentication method)



152
153
154
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 152

def k8s_password
  @k8s_password
end

#k8s_skip_system ⇒ Object

K8s Skip Control Plane Secrets, This option allows to avoid importing secrets from system namespaces (relevant only for K8s migration)



155
156
157
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 155

def k8s_skip_system
  @k8s_skip_system
end

#k8s_token ⇒ Object

For Token Authentication method K8s Bearer Token with sufficient permission to list and get secrets in the namespace(s) you selected (relevant only for K8s migration with Token Authentication method)



158
159
160
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 158

def k8s_token
  @k8s_token
end

#k8s_url ⇒ Object

K8s API Server URL, e.g. k8s-api.mycompany.com:6443 (relevant only for K8s migration)



161
162
163
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 161

def k8s_url
  @k8s_url
end

#k8s_username ⇒ Object

For Password Authentication method K8s Client username with sufficient permission to list and get secrets in the namespace(s) you selected (relevant only for K8s migration with Password Authentication method)



164
165
166
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 164

def k8s_username
  @k8s_username
end

#name ⇒ Object

Migration name



167
168
169
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 167

def name
  @name
end

#protection_key ⇒ Object

The name of the key that protects the classic key value (if empty, the account default key will be used)



170
171
172
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 170

def protection_key
  @protection_key
end

#si_auto_rotate ⇒ Object

Enable/Disable automatic/recurrent rotation for migrated secrets. Default is false: only manual rotation is allowed for migrated secrets. If set to true, this command should be combined with –si-rotation-interval and –si-rotation-hour parameters (Relevant only for Server Inventory migration)



173
174
175
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 173

def si_auto_rotate
  @si_auto_rotate
end

#si_rotation_hour ⇒ Object

The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)



176
177
178
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 176

def si_rotation_hour
  @si_rotation_hour
end

#si_rotation_interval ⇒ Object

The number of days to wait between every automatic rotation [1-365] (Relevant only for Server Inventory migration)



179
180
181
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 179

def si_rotation_interval
  @si_rotation_interval
end

#si_sra_enable_rdp ⇒ Object

Enable/Disable RDP Secure Remote Access for the migrated local users rotated secrets. Default is false: rotated secrets will not be created with SRA (Relevant only for Server Inventory migration)



182
183
184
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 182

def si_sra_enable_rdp
  @si_sra_enable_rdp
end

#si_target_name ⇒ Object

SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)



185
186
187
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 185

def si_target_name
  @si_target_name
end

#si_user_groups ⇒ Object

Comma-separated list of groups to migrate users from. If empty, all users from all groups will be migrated (Relevant only for Server Inventory migration)



188
189
190
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 188

def si_user_groups
  @si_user_groups
end

#si_users_ignore ⇒ Object

Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)



191
192
193
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 191

def si_users_ignore
  @si_users_ignore
end

#si_users_path_template ⇒ Object

Path location template for migrating users as Rotated Secrets e.g.: …/Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)



194
195
196
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 194

def si_users_path_template
  @si_users_path_template
end

#target_location ⇒ Object

Target location in Akeyless for imported secrets



197
198
199
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 197

def target_location
  @target_location
end

#token ⇒ Object

Authentication token (see ‘/auth` and `/configure`)



200
201
202
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 200

def token
  @token
end

#type ⇒ Object

Migration type (hashi/aws/gcp/k8s/azure_kv/1password/active_directory)



203
204
205
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 203

def type
  @type
end

#uid_token ⇒ Object

The universal identity token, Required only for universal_identity authentication



206
207
208
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 206

def uid_token
  @uid_token
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 809

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Akeyless.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



278
279
280
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 278

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 209

def self.attribute_map
  {
    :'_1password_email' => :'1password-email',
    :'_1password_password' => :'1password-password',
    :'_1password_secret_key' => :'1password-secret-key',
    :'_1password_url' => :'1password-url',
    :'_1password_vaults' => :'1password-vaults',
    :'ad_discover_services' => :'ad-discover-services',
    :'ad_discovery_types' => :'ad-discovery-types',
    :'ad_os_filter' => :'ad-os-filter',
    :'ad_ssh_port' => :'ad-ssh-port',
    :'ad_target_format' => :'ad-target-format',
    :'ad_targets_type' => :'ad-targets-type',
    :'ad_winrm_over_http' => :'ad-winrm-over-http',
    :'ad_winrm_port' => :'ad-winrm-port',
    :'ad_auto_rotate' => :'ad_auto_rotate',
    :'ad_computer_base_dn' => :'ad_computer_base_dn',
    :'ad_discover_local_users' => :'ad_discover_local_users',
    :'ad_domain_name' => :'ad_domain_name',
    :'ad_domain_users_path_template' => :'ad_domain_users_path_template',
    :'ad_local_users_ignore' => :'ad_local_users_ignore',
    :'ad_local_users_path_template' => :'ad_local_users_path_template',
    :'ad_rotation_hour' => :'ad_rotation_hour',
    :'ad_rotation_interval' => :'ad_rotation_interval',
    :'ad_sra_enable_rdp' => :'ad_sra_enable_rdp',
    :'ad_target_name' => :'ad_target_name',
    :'ad_targets_path_template' => :'ad_targets_path_template',
    :'ad_user_base_dn' => :'ad_user_base_dn',
    :'ad_user_groups' => :'ad_user_groups',
    :'aws_key' => :'aws-key',
    :'aws_key_id' => :'aws-key-id',
    :'aws_region' => :'aws-region',
    :'azure_client_id' => :'azure-client-id',
    :'azure_kv_name' => :'azure-kv-name',
    :'azure_secret' => :'azure-secret',
    :'azure_tenant_id' => :'azure-tenant-id',
    :'gcp_key' => :'gcp-key',
    :'hashi_json' => :'hashi-json',
    :'hashi_ns' => :'hashi-ns',
    :'hashi_token' => :'hashi-token',
    :'hashi_url' => :'hashi-url',
    :'json' => :'json',
    :'k8s_ca_certificate' => :'k8s-ca-certificate',
    :'k8s_client_certificate' => :'k8s-client-certificate',
    :'k8s_client_key' => :'k8s-client-key',
    :'k8s_namespace' => :'k8s-namespace',
    :'k8s_password' => :'k8s-password',
    :'k8s_skip_system' => :'k8s-skip-system',
    :'k8s_token' => :'k8s-token',
    :'k8s_url' => :'k8s-url',
    :'k8s_username' => :'k8s-username',
    :'name' => :'name',
    :'protection_key' => :'protection-key',
    :'si_auto_rotate' => :'si-auto-rotate',
    :'si_rotation_hour' => :'si-rotation-hour',
    :'si_rotation_interval' => :'si-rotation-interval',
    :'si_sra_enable_rdp' => :'si-sra-enable-rdp',
    :'si_target_name' => :'si-target-name',
    :'si_user_groups' => :'si-user-groups',
    :'si_users_ignore' => :'si-users-ignore',
    :'si_users_path_template' => :'si-users-path-template',
    :'target_location' => :'target-location',
    :'token' => :'token',
    :'type' => :'type',
    :'uid_token' => :'uid-token'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 785

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



352
353
354
355
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 352

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 283

def self.openapi_types
  {
    :'_1password_email' => :'String',
    :'_1password_password' => :'String',
    :'_1password_secret_key' => :'String',
    :'_1password_url' => :'String',
    :'_1password_vaults' => :'Array<String>',
    :'ad_discover_services' => :'String',
    :'ad_discovery_types' => :'Array<String>',
    :'ad_os_filter' => :'String',
    :'ad_ssh_port' => :'String',
    :'ad_target_format' => :'String',
    :'ad_targets_type' => :'String',
    :'ad_winrm_over_http' => :'String',
    :'ad_winrm_port' => :'String',
    :'ad_auto_rotate' => :'String',
    :'ad_computer_base_dn' => :'String',
    :'ad_discover_local_users' => :'String',
    :'ad_domain_name' => :'String',
    :'ad_domain_users_path_template' => :'String',
    :'ad_local_users_ignore' => :'String',
    :'ad_local_users_path_template' => :'String',
    :'ad_rotation_hour' => :'Integer',
    :'ad_rotation_interval' => :'Integer',
    :'ad_sra_enable_rdp' => :'String',
    :'ad_target_name' => :'String',
    :'ad_targets_path_template' => :'String',
    :'ad_user_base_dn' => :'String',
    :'ad_user_groups' => :'String',
    :'aws_key' => :'String',
    :'aws_key_id' => :'String',
    :'aws_region' => :'String',
    :'azure_client_id' => :'String',
    :'azure_kv_name' => :'String',
    :'azure_secret' => :'String',
    :'azure_tenant_id' => :'String',
    :'gcp_key' => :'String',
    :'hashi_json' => :'String',
    :'hashi_ns' => :'Array<String>',
    :'hashi_token' => :'String',
    :'hashi_url' => :'String',
    :'json' => :'Boolean',
    :'k8s_ca_certificate' => :'Array<Integer>',
    :'k8s_client_certificate' => :'Array<Integer>',
    :'k8s_client_key' => :'Array<Integer>',
    :'k8s_namespace' => :'String',
    :'k8s_password' => :'String',
    :'k8s_skip_system' => :'Boolean',
    :'k8s_token' => :'String',
    :'k8s_url' => :'String',
    :'k8s_username' => :'String',
    :'name' => :'String',
    :'protection_key' => :'String',
    :'si_auto_rotate' => :'String',
    :'si_rotation_hour' => :'Integer',
    :'si_rotation_interval' => :'Integer',
    :'si_sra_enable_rdp' => :'String',
    :'si_target_name' => :'String',
    :'si_user_groups' => :'String',
    :'si_users_ignore' => :'String',
    :'si_users_path_template' => :'String',
    :'target_location' => :'String',
    :'token' => :'String',
    :'type' => :'String',
    :'uid_token' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 702

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      _1password_email == o._1password_email &&
      _1password_password == o._1password_password &&
      _1password_secret_key == o._1password_secret_key &&
      _1password_url == o._1password_url &&
      _1password_vaults == o._1password_vaults &&
      ad_discover_services == o.ad_discover_services &&
      ad_discovery_types == o.ad_discovery_types &&
      ad_os_filter == o.ad_os_filter &&
      ad_ssh_port == o.ad_ssh_port &&
      ad_target_format == o.ad_target_format &&
      ad_targets_type == o.ad_targets_type &&
      ad_winrm_over_http == o.ad_winrm_over_http &&
      ad_winrm_port == o.ad_winrm_port &&
      ad_auto_rotate == o.ad_auto_rotate &&
      ad_computer_base_dn == o.ad_computer_base_dn &&
      ad_discover_local_users == o.ad_discover_local_users &&
      ad_domain_name == o.ad_domain_name &&
      ad_domain_users_path_template == o.ad_domain_users_path_template &&
      ad_local_users_ignore == o.ad_local_users_ignore &&
      ad_local_users_path_template == o.ad_local_users_path_template &&
      ad_rotation_hour == o.ad_rotation_hour &&
      ad_rotation_interval == o.ad_rotation_interval &&
      ad_sra_enable_rdp == o.ad_sra_enable_rdp &&
      ad_target_name == o.ad_target_name &&
      ad_targets_path_template == o.ad_targets_path_template &&
      ad_user_base_dn == o.ad_user_base_dn &&
      ad_user_groups == o.ad_user_groups &&
      aws_key == o.aws_key &&
      aws_key_id == o.aws_key_id &&
      aws_region == o.aws_region &&
      azure_client_id == o.azure_client_id &&
      azure_kv_name == o.azure_kv_name &&
      azure_secret == o.azure_secret &&
      azure_tenant_id == o.azure_tenant_id &&
      gcp_key == o.gcp_key &&
      hashi_json == o.hashi_json &&
      hashi_ns == o.hashi_ns &&
      hashi_token == o.hashi_token &&
      hashi_url == o.hashi_url &&
      json == o.json &&
      k8s_ca_certificate == o.k8s_ca_certificate &&
      k8s_client_certificate == o.k8s_client_certificate &&
      k8s_client_key == o.k8s_client_key &&
      k8s_namespace == o.k8s_namespace &&
      k8s_password == o.k8s_password &&
      k8s_skip_system == o.k8s_skip_system &&
      k8s_token == o.k8s_token &&
      k8s_url == o.k8s_url &&
      k8s_username == o.k8s_username &&
      name == o.name &&
      protection_key == o.protection_key &&
      si_auto_rotate == o.si_auto_rotate &&
      si_rotation_hour == o.si_rotation_hour &&
      si_rotation_interval == o.si_rotation_interval &&
      si_sra_enable_rdp == o.si_sra_enable_rdp &&
      si_target_name == o.si_target_name &&
      si_user_groups == o.si_user_groups &&
      si_users_ignore == o.si_users_ignore &&
      si_users_path_template == o.si_users_path_template &&
      target_location == o.target_location &&
      token == o.token &&
      type == o.type &&
      uid_token == o.uid_token
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



880
881
882
883
884
885
886
887
888
889
890
891
892
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 880

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


772
773
774
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 772

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



778
779
780
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 778

def hash
  [_1password_email, _1password_password, _1password_secret_key, _1password_url, _1password_vaults, ad_discover_services, ad_discovery_types, ad_os_filter, ad_ssh_port, ad_target_format, ad_targets_type, ad_winrm_over_http, ad_winrm_port, ad_auto_rotate, ad_computer_base_dn, ad_discover_local_users, ad_domain_name, ad_domain_users_path_template, ad_local_users_ignore, ad_local_users_path_template, ad_rotation_hour, ad_rotation_interval, ad_sra_enable_rdp, ad_target_name, ad_targets_path_template, ad_user_base_dn, ad_user_groups, aws_key, aws_key_id, aws_region, azure_client_id, azure_kv_name, azure_secret, azure_tenant_id, gcp_key, hashi_json, hashi_ns, hashi_token, hashi_url, json, k8s_ca_certificate, k8s_client_certificate, k8s_client_key, k8s_namespace, k8s_password, k8s_skip_system, k8s_token, k8s_url, k8s_username, name, protection_key, si_auto_rotate, si_rotation_hour, si_rotation_interval, si_sra_enable_rdp, si_target_name, si_user_groups, si_users_ignore, si_users_path_template, target_location, token, type, uid_token].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 667

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @si_target_name.nil?
    invalid_properties.push('invalid value for "si_target_name", si_target_name cannot be nil.')
  end

  if @si_users_path_template.nil?
    invalid_properties.push('invalid value for "si_users_path_template", si_users_path_template cannot be nil.')
  end

  if @target_location.nil?
    invalid_properties.push('invalid value for "target_location", target_location cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



856
857
858
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 856

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



862
863
864
865
866
867
868
869
870
871
872
873
874
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 862

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



850
851
852
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 850

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



691
692
693
694
695
696
697
698
 
# File 'lib/akeyless/models/gateway_create_migration.rb', line 691

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @name.nil?
  return false if @si_target_name.nil?
  return false if @si_users_path_template.nil?
  return false if @target_location.nil?
  true
end