published on Thursday, Nov 19, 2026 by akeyless-community
published on Thursday, Nov 19, 2026 by akeyless-community
Server Inventory Migration resource
Create GatewayMigrationServerInventory Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new GatewayMigrationServerInventory(name: string, args: GatewayMigrationServerInventoryArgs, opts?: CustomResourceOptions);@overload
def GatewayMigrationServerInventory(resource_name: str,
args: GatewayMigrationServerInventoryArgs,
opts: Optional[ResourceOptions] = None)
@overload
def GatewayMigrationServerInventory(resource_name: str,
opts: Optional[ResourceOptions] = None,
si_target_name: Optional[str] = None,
hosts: Optional[str] = None,
target_location: Optional[str] = None,
si_users_path_template: Optional[str] = None,
protection_key: Optional[str] = None,
si_auto_rotate: Optional[str] = None,
si_rotation_hour: Optional[float] = None,
si_rotation_interval: Optional[float] = None,
si_sra_enable_rdp: Optional[str] = None,
retry: Optional[GatewayMigrationServerInventoryRetryArgs] = None,
si_user_groups: Optional[str] = None,
si_users_ignore: Optional[str] = None,
gateway_migration_server_inventory_id: Optional[str] = None,
name: Optional[str] = None)func NewGatewayMigrationServerInventory(ctx *Context, name string, args GatewayMigrationServerInventoryArgs, opts ...ResourceOption) (*GatewayMigrationServerInventory, error)public GatewayMigrationServerInventory(string name, GatewayMigrationServerInventoryArgs args, CustomResourceOptions? opts = null)
public GatewayMigrationServerInventory(String name, GatewayMigrationServerInventoryArgs args)
public GatewayMigrationServerInventory(String name, GatewayMigrationServerInventoryArgs args, CustomResourceOptions options)
type: akeyless:GatewayMigrationServerInventory
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "akeyless_gateway_migration_server_inventory" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args GatewayMigrationServerInventoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args GatewayMigrationServerInventoryArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args GatewayMigrationServerInventoryArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args GatewayMigrationServerInventoryArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args GatewayMigrationServerInventoryArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var gatewayMigrationServerInventoryResource = new Akeyless.GatewayMigrationServerInventory("gatewayMigrationServerInventoryResource", new()
{
SiTargetName = "string",
Hosts = "string",
TargetLocation = "string",
SiUsersPathTemplate = "string",
ProtectionKey = "string",
SiAutoRotate = "string",
SiRotationHour = 0.0,
SiRotationInterval = 0.0,
SiSraEnableRdp = "string",
Retry = new Akeyless.Inputs.GatewayMigrationServerInventoryRetryArgs
{
ErrorMessageRegexes = new[]
{
"string",
},
IntervalSeconds = 0.0,
MaxIntervalSeconds = 0.0,
MaxRetries = 0.0,
RetryOnStatusCodes = new[]
{
0.0,
},
},
SiUserGroups = "string",
SiUsersIgnore = "string",
GatewayMigrationServerInventoryId = "string",
Name = "string",
});
example, err := akeyless.NewGatewayMigrationServerInventory(ctx, "gatewayMigrationServerInventoryResource", &akeyless.GatewayMigrationServerInventoryArgs{
SiTargetName: pulumi.String("string"),
Hosts: pulumi.String("string"),
TargetLocation: pulumi.String("string"),
SiUsersPathTemplate: pulumi.String("string"),
ProtectionKey: pulumi.String("string"),
SiAutoRotate: pulumi.String("string"),
SiRotationHour: pulumi.Float64(0),
SiRotationInterval: pulumi.Float64(0),
SiSraEnableRdp: pulumi.String("string"),
Retry: &akeyless.GatewayMigrationServerInventoryRetryArgs{
ErrorMessageRegexes: pulumi.StringArray{
pulumi.String("string"),
},
IntervalSeconds: pulumi.Float64(0),
MaxIntervalSeconds: pulumi.Float64(0),
MaxRetries: pulumi.Float64(0),
RetryOnStatusCodes: pulumi.Float64Array{
pulumi.Float64(0),
},
},
SiUserGroups: pulumi.String("string"),
SiUsersIgnore: pulumi.String("string"),
GatewayMigrationServerInventoryId: pulumi.String("string"),
Name: pulumi.String("string"),
})
resource "akeyless_gateway_migration_server_inventory" "gatewayMigrationServerInventoryResource" {
lifecycle {
create_before_destroy = true
}
si_target_name = "string"
hosts = "string"
target_location = "string"
si_users_path_template = "string"
protection_key = "string"
si_auto_rotate = "string"
si_rotation_hour = 0
si_rotation_interval = 0
si_sra_enable_rdp = "string"
retry = {
error_message_regexes = ["string"]
interval_seconds = 0
max_interval_seconds = 0
max_retries = 0
retry_on_status_codes = [0]
}
si_user_groups = "string"
si_users_ignore = "string"
gateway_migration_server_inventory_id = "string"
name = "string"
}
var gatewayMigrationServerInventoryResource = new GatewayMigrationServerInventory("gatewayMigrationServerInventoryResource", GatewayMigrationServerInventoryArgs.builder()
.siTargetName("string")
.hosts("string")
.targetLocation("string")
.siUsersPathTemplate("string")
.protectionKey("string")
.siAutoRotate("string")
.siRotationHour(0.0)
.siRotationInterval(0.0)
.siSraEnableRdp("string")
.retry(GatewayMigrationServerInventoryRetryArgs.builder()
.errorMessageRegexes("string")
.intervalSeconds(0.0)
.maxIntervalSeconds(0.0)
.maxRetries(0.0)
.retryOnStatusCodes(0.0)
.build())
.siUserGroups("string")
.siUsersIgnore("string")
.gatewayMigrationServerInventoryId("string")
.name("string")
.build());
gateway_migration_server_inventory_resource = akeyless.GatewayMigrationServerInventory("gatewayMigrationServerInventoryResource",
si_target_name="string",
hosts="string",
target_location="string",
si_users_path_template="string",
protection_key="string",
si_auto_rotate="string",
si_rotation_hour=float(0),
si_rotation_interval=float(0),
si_sra_enable_rdp="string",
retry={
"error_message_regexes": ["string"],
"interval_seconds": float(0),
"max_interval_seconds": float(0),
"max_retries": float(0),
"retry_on_status_codes": [float(0)],
},
si_user_groups="string",
si_users_ignore="string",
gateway_migration_server_inventory_id="string",
name="string")
const gatewayMigrationServerInventoryResource = new akeyless.GatewayMigrationServerInventory("gatewayMigrationServerInventoryResource", {
siTargetName: "string",
hosts: "string",
targetLocation: "string",
siUsersPathTemplate: "string",
protectionKey: "string",
siAutoRotate: "string",
siRotationHour: 0,
siRotationInterval: 0,
siSraEnableRdp: "string",
retry: {
errorMessageRegexes: ["string"],
intervalSeconds: 0,
maxIntervalSeconds: 0,
maxRetries: 0,
retryOnStatusCodes: [0],
},
siUserGroups: "string",
siUsersIgnore: "string",
gatewayMigrationServerInventoryId: "string",
name: "string",
});
type: akeyless:GatewayMigrationServerInventory
properties:
gatewayMigrationServerInventoryId: string
hosts: string
name: string
protectionKey: string
retry:
errorMessageRegexes:
- string
intervalSeconds: 0
maxIntervalSeconds: 0
maxRetries: 0
retryOnStatusCodes:
- 0
siAutoRotate: string
siRotationHour: 0
siRotationInterval: 0
siSraEnableRdp: string
siTargetName: string
siUserGroups: string
siUsersIgnore: string
siUsersPathTemplate: string
targetLocation: string
GatewayMigrationServerInventory Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The GatewayMigrationServerInventory resource accepts the following input properties:
- Hosts string
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- Si
Target stringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- Si
Users stringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- Target
Location string - Target location in Akeyless for imported secrets
- Gateway
Migration stringServer Inventory Id - The ID of this resource.
- Name string
- Migration name
- Protection
Key string - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- Retry
Gateway
Migration Server Inventory Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Si
Auto stringRotate - 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)
- Si
Rotation doubleHour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- Si
Rotation doubleInterval - The number of days to wait between every automatic rotation 1-365
- Si
Sra stringEnable Rdp - 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)
- Si
User stringGroups - 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)
- Si
Users stringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- Hosts string
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- Si
Target stringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- Si
Users stringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- Target
Location string - Target location in Akeyless for imported secrets
- Gateway
Migration stringServer Inventory Id - The ID of this resource.
- Name string
- Migration name
- Protection
Key string - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- Retry
Gateway
Migration Server Inventory Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Si
Auto stringRotate - 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)
- Si
Rotation float64Hour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- Si
Rotation float64Interval - The number of days to wait between every automatic rotation 1-365
- Si
Sra stringEnable Rdp - 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)
- Si
User stringGroups - 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)
- Si
Users stringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- hosts string
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- si_
target_ stringname - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si_
users_ stringpath_ template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target_
location string - Target location in Akeyless for imported secrets
- gateway_
migration_ stringserver_ inventory_ id - The ID of this resource.
- name string
- Migration name
- protection_
key string - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si_
auto_ stringrotate - 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)
- si_
rotation_ numberhour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si_
rotation_ numberinterval - The number of days to wait between every automatic rotation 1-365
- si_
sra_ stringenable_ rdp - 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)
- si_
user_ stringgroups - 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)
- si_
users_ stringignore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- hosts String
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- si
Target StringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si
Users StringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target
Location String - Target location in Akeyless for imported secrets
- gateway
Migration StringServer Inventory Id - The ID of this resource.
- name String
- Migration name
- protection
Key String - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry
Gateway
Migration Server Inventory Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si
Auto StringRotate - 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)
- si
Rotation DoubleHour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si
Rotation DoubleInterval - The number of days to wait between every automatic rotation 1-365
- si
Sra StringEnable Rdp - 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)
- si
User StringGroups - 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)
- si
Users StringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- hosts string
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- si
Target stringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si
Users stringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target
Location string - Target location in Akeyless for imported secrets
- gateway
Migration stringServer Inventory Id - The ID of this resource.
- name string
- Migration name
- protection
Key string - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry
Gateway
Migration Server Inventory Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si
Auto stringRotate - 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)
- si
Rotation numberHour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si
Rotation numberInterval - The number of days to wait between every automatic rotation 1-365
- si
Sra stringEnable Rdp - 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)
- si
User stringGroups - 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)
- si
Users stringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- hosts str
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- si_
target_ strname - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si_
users_ strpath_ template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target_
location str - Target location in Akeyless for imported secrets
- gateway_
migration_ strserver_ inventory_ id - The ID of this resource.
- name str
- Migration name
- protection_
key str - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry
Gateway
Migration Server Inventory Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si_
auto_ strrotate - 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)
- si_
rotation_ floathour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si_
rotation_ floatinterval - The number of days to wait between every automatic rotation 1-365
- si_
sra_ strenable_ rdp - 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)
- si_
user_ strgroups - 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)
- si_
users_ strignore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- hosts String
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- si
Target StringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si
Users StringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target
Location String - Target location in Akeyless for imported secrets
- gateway
Migration StringServer Inventory Id - The ID of this resource.
- name String
- Migration name
- protection
Key String - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si
Auto StringRotate - 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)
- si
Rotation NumberHour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si
Rotation NumberInterval - The number of days to wait between every automatic rotation 1-365
- si
Sra StringEnable Rdp - 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)
- si
User StringGroups - 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)
- si
Users StringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
Outputs
All input properties are implicitly available as output properties. Additionally, the GatewayMigrationServerInventory resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Migration
Id string - Migration ID
- Id string
- The provider-assigned unique ID for this managed resource.
- Migration
Id string - Migration ID
- id string
- The provider-assigned unique ID for this managed resource.
- migration_
id string - Migration ID
- id String
- The provider-assigned unique ID for this managed resource.
- migration
Id String - Migration ID
- id string
- The provider-assigned unique ID for this managed resource.
- migration
Id string - Migration ID
- id str
- The provider-assigned unique ID for this managed resource.
- migration_
id str - Migration ID
- id String
- The provider-assigned unique ID for this managed resource.
- migration
Id String - Migration ID
Look up Existing GatewayMigrationServerInventory Resource
Get an existing GatewayMigrationServerInventory resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: GatewayMigrationServerInventoryState, opts?: CustomResourceOptions): GatewayMigrationServerInventory@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
gateway_migration_server_inventory_id: Optional[str] = None,
hosts: Optional[str] = None,
migration_id: Optional[str] = None,
name: Optional[str] = None,
protection_key: Optional[str] = None,
retry: Optional[GatewayMigrationServerInventoryRetryArgs] = None,
si_auto_rotate: Optional[str] = None,
si_rotation_hour: Optional[float] = None,
si_rotation_interval: Optional[float] = None,
si_sra_enable_rdp: Optional[str] = None,
si_target_name: Optional[str] = None,
si_user_groups: Optional[str] = None,
si_users_ignore: Optional[str] = None,
si_users_path_template: Optional[str] = None,
target_location: Optional[str] = None) -> GatewayMigrationServerInventoryfunc GetGatewayMigrationServerInventory(ctx *Context, name string, id IDInput, state *GatewayMigrationServerInventoryState, opts ...ResourceOption) (*GatewayMigrationServerInventory, error)public static GatewayMigrationServerInventory Get(string name, Input<string> id, GatewayMigrationServerInventoryState? state, CustomResourceOptions? opts = null)public static GatewayMigrationServerInventory get(String name, Output<String> id, GatewayMigrationServerInventoryState state, CustomResourceOptions options)resources: existingGatewayMigrationServerInventory: type: akeyless:GatewayMigrationServerInventory get: id: ${id}import {
to = akeyless_gateway_migration_server_inventory.example
id = "${id}"
}
- name string
- The unique name of the resulting resource.
- id Input<ID>
- The unique provider ID of the resource to look up.
- state GatewayMigrationServerInventoryState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resulting resource.
- id str
- The unique provider ID of the resource to look up.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resulting resource.
- id IDInput
- The unique provider ID of the resource to look up.
- state GatewayMigrationServerInventoryState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resulting resource.
- id Input<string>
- The unique provider ID of the resource to look up.
- state GatewayMigrationServerInventoryState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resulting resource.
- id Output<String>
- The unique provider ID of the resource to look up.
- state GatewayMigrationServerInventoryState
- Known property values the provider needs, along with the ID, to find the resource. Usually not required.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
- Gateway
Migration stringServer Inventory Id - The ID of this resource.
- Hosts string
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- Migration
Id string - Migration ID
- Name string
- Migration name
- Protection
Key string - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- Retry
Gateway
Migration Server Inventory Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Si
Auto stringRotate - 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)
- Si
Rotation doubleHour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- Si
Rotation doubleInterval - The number of days to wait between every automatic rotation 1-365
- Si
Sra stringEnable Rdp - 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)
- Si
Target stringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- Si
User stringGroups - 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)
- Si
Users stringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- Si
Users stringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- Target
Location string - Target location in Akeyless for imported secrets
- Gateway
Migration stringServer Inventory Id - The ID of this resource.
- Hosts string
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- Migration
Id string - Migration ID
- Name string
- Migration name
- Protection
Key string - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- Retry
Gateway
Migration Server Inventory Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- Si
Auto stringRotate - 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)
- Si
Rotation float64Hour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- Si
Rotation float64Interval - The number of days to wait between every automatic rotation 1-365
- Si
Sra stringEnable Rdp - 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)
- Si
Target stringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- Si
User stringGroups - 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)
- Si
Users stringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- Si
Users stringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- Target
Location string - Target location in Akeyless for imported secrets
- gateway_
migration_ stringserver_ inventory_ id - The ID of this resource.
- hosts string
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- migration_
id string - Migration ID
- name string
- Migration name
- protection_
key string - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry object
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si_
auto_ stringrotate - 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)
- si_
rotation_ numberhour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si_
rotation_ numberinterval - The number of days to wait between every automatic rotation 1-365
- si_
sra_ stringenable_ rdp - 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)
- si_
target_ stringname - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si_
user_ stringgroups - 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)
- si_
users_ stringignore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- si_
users_ stringpath_ template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target_
location string - Target location in Akeyless for imported secrets
- gateway
Migration StringServer Inventory Id - The ID of this resource.
- hosts String
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- migration
Id String - Migration ID
- name String
- Migration name
- protection
Key String - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry
Gateway
Migration Server Inventory Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si
Auto StringRotate - 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)
- si
Rotation DoubleHour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si
Rotation DoubleInterval - The number of days to wait between every automatic rotation 1-365
- si
Sra StringEnable Rdp - 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)
- si
Target StringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si
User StringGroups - 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)
- si
Users StringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- si
Users StringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target
Location String - Target location in Akeyless for imported secrets
- gateway
Migration stringServer Inventory Id - The ID of this resource.
- hosts string
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- migration
Id string - Migration ID
- name string
- Migration name
- protection
Key string - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry
Gateway
Migration Server Inventory Retry - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si
Auto stringRotate - 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)
- si
Rotation numberHour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si
Rotation numberInterval - The number of days to wait between every automatic rotation 1-365
- si
Sra stringEnable Rdp - 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)
- si
Target stringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si
User stringGroups - 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)
- si
Users stringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- si
Users stringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target
Location string - Target location in Akeyless for imported secrets
- gateway_
migration_ strserver_ inventory_ id - The ID of this resource.
- hosts str
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- migration_
id str - Migration ID
- name str
- Migration name
- protection_
key str - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry
Gateway
Migration Server Inventory Retry Args - Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si_
auto_ strrotate - 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)
- si_
rotation_ floathour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si_
rotation_ floatinterval - The number of days to wait between every automatic rotation 1-365
- si_
sra_ strenable_ rdp - 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)
- si_
target_ strname - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si_
user_ strgroups - 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)
- si_
users_ strignore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- si_
users_ strpath_ template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target_
location str - Target location in Akeyless for imported secrets
- gateway
Migration StringServer Inventory Id - The ID of this resource.
- hosts String
- A comma separated list of IPs, CIDR ranges, or DNS names to scan
- migration
Id String - Migration ID
- name String
- Migration name
- protection
Key String - The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)
- retry Property Map
- Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
- si
Auto StringRotate - 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)
- si
Rotation NumberHour - The hour of the scheduled rotation in UTC (Relevant only for Server Inventory migration)
- si
Rotation NumberInterval - The number of days to wait between every automatic rotation 1-365
- si
Sra StringEnable Rdp - 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)
- si
Target StringName - SSH, Windows or Linked Target Name. (Relevant only for Server Inventory migration)
- si
User StringGroups - 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)
- si
Users StringIgnore - Comma-separated list of Local Users which should not be migrated (Relevant only for Server Inventory migration)
- si
Users StringPath Template - Path location template for migrating users as Rotated Secrets e.g.: .../Users/{COMPUTER_NAME}/{USERNAME} (Relevant only for Server Inventory migration)
- target
Location String - Target location in Akeyless for imported secrets
Supporting Types
GatewayMigrationServerInventoryRetry, GatewayMigrationServerInventoryRetryArgs
- Error
Message List<string>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds double - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval doubleSeconds - Maximum wait between retries, in seconds.
- Max
Retries double - Maximum number of retries after the first attempt.
- Retry
On List<double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- Error
Message []stringRegexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- Interval
Seconds float64 - Wait before the first retry, in seconds. The wait doubles on each retry.
- Max
Interval float64Seconds - Maximum wait between retries, in seconds.
- Max
Retries float64 - Maximum number of retries after the first attempt.
- Retry
On []float64Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ list(string)regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ numberseconds - Maximum wait between retries, in seconds.
- max_
retries number - Maximum number of retries after the first attempt.
- retry_
on_ list(number)status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Double - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval DoubleSeconds - Maximum wait between retries, in seconds.
- max
Retries Double - Maximum number of retries after the first attempt.
- retry
On List<Double>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message string[]Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval numberSeconds - Maximum wait between retries, in seconds.
- max
Retries number - Maximum number of retries after the first attempt.
- retry
On number[]Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error_
message_ Sequence[str]regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval_
seconds float - Wait before the first retry, in seconds. The wait doubles on each retry.
- max_
interval_ floatseconds - Maximum wait between retries, in seconds.
- max_
retries float - Maximum number of retries after the first attempt.
- retry_
on_ Sequence[float]status_ codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
- error
Message List<String>Regexes - Regular expressions matched against the error message. If any matches, the operation is retried.
- interval
Seconds Number - Wait before the first retry, in seconds. The wait doubles on each retry.
- max
Interval NumberSeconds - Maximum wait between retries, in seconds.
- max
Retries Number - Maximum number of retries after the first attempt.
- retry
On List<Number>Status Codes - HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
Package Details
- Repository
- akeyless akeyless-community/terraform-provider-akeyless
- License
- Notes
- This Pulumi package is based on the
akeylessTerraform Provider.
published on Thursday, Nov 19, 2026 by akeyless-community