Dagger
Search

ssh

No long description provided.

Installation

dagger install github.com/felipepimentel/daggerverse/essentials/ssh@v0.0.0

Entrypoint

Return Type 
Ssh !
Arguments
NameTypeDefault ValueDescription
destinationString !-No description provided
identityFileSecret !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/essentials/ssh@36e606fe6b7d1c9561dc60db82ab31614b838754 call \
 --destination string --identity-file env:MYSECRET
func (m *myModule) example(destination string, identityFile *Secret) *Ssh  {
	return dag.
			Ssh(destination, identityFile)
}
@function
def example(destination: str, identity_file: dagger.Secret) -> dag.Ssh:
	return (
		dag.ssh(destination, identity_file)
	)
@func()
example(destination: string, identityFile: Secret): Ssh {
	return dag
		.ssh(destination, identityFile)
}

Types

Ssh 🔗

baseCtr() 🔗

Return Type 
Container !
Example
dagger -m github.com/felipepimentel/daggerverse/essentials/ssh@36e606fe6b7d1c9561dc60db82ab31614b838754 call \
 --destination string --identity-file env:MYSECRET base-ctr
func (m *myModule) example(destination string, identityFile *Secret) *Container  {
	return dag.
			Ssh(destination, identityFile).
			BaseCtr()
}
@function
def example(destination: str, identity_file: dagger.Secret) -> dagger.Container:
	return (
		dag.ssh(destination, identity_file)
		.base_ctr()
	)
@func()
example(destination: string, identityFile: Secret): Container {
	return dag
		.ssh(destination, identityFile)
		.baseCtr()
}

destination() 🔗

Return Type 
String !
Example
dagger -m github.com/felipepimentel/daggerverse/essentials/ssh@36e606fe6b7d1c9561dc60db82ab31614b838754 call \
 --destination string --identity-file env:MYSECRET destination
func (m *myModule) example(ctx context.Context, destination string, identityFile *Secret) string  {
	return dag.
			Ssh(destination, identityFile).
			Destination(ctx)
}
@function
async def example(destination: str, identity_file: dagger.Secret) -> str:
	return await (
		dag.ssh(destination, identity_file)
		.destination()
	)
@func()
async example(destination: string, identityFile: Secret): Promise<string> {
	return dag
		.ssh(destination, identityFile)
		.destination()
}

opts() 🔗

Return Type 
[Opts ! ] !
Example
dagger -m github.com/felipepimentel/daggerverse/essentials/ssh@36e606fe6b7d1c9561dc60db82ab31614b838754 call \
 --destination string --identity-file env:MYSECRET opts
func (m *myModule) example(destination string, identityFile *Secret) []*SshOpts  {
	return dag.
			Ssh(destination, identityFile).
			Opts()
}
@function
def example(destination: str, identity_file: dagger.Secret) -> List[dag.SshOpts]:
	return (
		dag.ssh(destination, identity_file)
		.opts()
	)
@func()
example(destination: string, identityFile: Secret): SshOpts[] {
	return dag
		.ssh(destination, identityFile)
		.opts()
}

command() 🔗

example usage: “dagger call –destination USER@HOST –identity-file file:${HOME}/.ssh/id_ed25519 command –args whoami stdout”

Return Type 
Container !
Arguments
NameTypeDefault ValueDescription
args[String ! ] !-No description provided
Example
dagger -m github.com/felipepimentel/daggerverse/essentials/ssh@36e606fe6b7d1c9561dc60db82ab31614b838754 call \
 --destination string --identity-file env:MYSECRET command --args string1 --args string2
func (m *myModule) example(destination string, identityFile *Secret, args []string) *Container  {
	return dag.
			Ssh(destination, identityFile).
			Command(args)
}
@function
def example(destination: str, identity_file: dagger.Secret, args: List[str]) -> dagger.Container:
	return (
		dag.ssh(destination, identity_file)
		.command(args)
	)
@func()
example(destination: string, identityFile: Secret, args: string[]): Container {
	return dag
		.ssh(destination, identityFile)
		.command(args)
}

Opts 🔗

identityFile() 🔗

Return Type 
Secret !
Example
Function SshOpts.identityFile is not accessible from the ssh module
Function SshOpts.identityFile is not accessible from the ssh module
Function SshOpts.identityFile is not accessible from the ssh module
Function SshOpts.identityFile is not accessible from the ssh module

port() 🔗

Return Type 
Integer !
Example
Function SshOpts.port is not accessible from the ssh module
Function SshOpts.port is not accessible from the ssh module
Function SshOpts.port is not accessible from the ssh module
Function SshOpts.port is not accessible from the ssh module

login() 🔗

Return Type 
String !
Example
Function SshOpts.login is not accessible from the ssh module
Function SshOpts.login is not accessible from the ssh module
Function SshOpts.login is not accessible from the ssh module
Function SshOpts.login is not accessible from the ssh module