Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help 
ECLAT-MKINST(1) 	      Eclat User Reference		 ECLAT-MKINST(1)

NAME
     eclat-mkinst, eclat-run-instances - launch new EC2 instances

SYNOPSIS
     eclat mkinst [-a IFACE] [-d STRING] [-f  FILE] [-g STRING] [-k ID] [-m
     DEV=SPEC] [-n N] [-p NAME] [-s ID] [-t TYPE] [-z ZONE] [--data=STRING]
     [--data-file=FILE] [--devmap=DEV=SPEC] [--block-device-mapping=DEV=SPEC]
     [--disable-api-termination] [--ebs-optimized] [--iam-profile=NAME]
     [--kernel=ID] [--keypair=ID] [--monitor] [--network-interface=IFACE]
     [--iface=IFACE] [--number-secondary-ip=N]
     [--secondary-private-ip-address-count=N] [--placement-group=NAME]
     [--private-ip-address=IP] [--ramdisk=ID] [--secondary-ip=IP]
     [--secondary-private-ip-address=IP] [--security-group=STRING]
     [--shutdown=stop|terminate]
     [--instance-initiated-shutdown-behavior=stop|terminate] [--subnet=ID]
     [--tenancy=STRING] [--type=TYPE] [--instance-type=TYPE] [--zone=ZONE]
     [--availability-zone=ZONE] AMI-ID

     eclat mkinst --help

DESCRIPTION
     The  mkinst command launches one or more EC2 instances from an existing AMI
     identified by the AMI-ID argument.  The number of instances  to  launch  is
     determined  by  the  -n  option.	In  its  absense,  one	instance will be
     launched.

     If ID mapping is enabled (see the section MAPS in	eclat(1)),  the  ImageId
     map is used to translate AMI-ID to the corresponding AMI identifier.

     Options supply additional details for the instances to be created.

OPTIONS
     -a, --network-interface, --iface=IFACE
	    Specify the network attachment for a VPC instance.

     -d, --data=STRING
	    User data to pass to the instance.

     --disable-api-termination
	    Disable API termination.

     --ebs-optimized
	    Optimize the instances for EBS I/O.

     -f, --data-file=FILE
	    Read user data from FILE.

     -g, --security-group=STRING
	    The name of the security group.

     -k, --keypair=ID
	    Key pair name.

     --kernel=fIID
	    Select kernel ID.

     -m, --devmap, --block-device-mapping=DEV=SPEC
	    Set  block	device	mapping.  The DEV part is the device name of the
	    physical device on the instance to map.  The SPEC sets  the  mapping
	    specification and can be one of:

	    none   Disable  the  existing  mapping.  E.g. -m /dev/xvdb=none dis-
		   ables the mapping for the device /dev/xvdb.

	    ephemeral[0-3]
		   Map	an  instance  store  volume  to  the  device.	E.g.  -m
		   /dev/xvdb=ephemeral1.

	    [snapshot-id]:[volume-size]:[DOT]:[standard|io1[:iops]]
		   Specifies  an  EBS  volume  to  be mapped to the device.  The
		   snapshot-id specifies the ID of the snapshot  to  create  the
		   volume from, volume-size gives the desired size of the volume
		   in  gigabytes.   The  DOT  parameter  (delete on termination)
		   specifies whether the device should be deleted after the  in-
		   stance  is  terminated.   Possible values are true and false.
		   The last parameter defines the volume type.	The value  stan-
		   dard  instructs  Amazon to create a standard volume.  This is
		   the default.  To create a provisioned  IOPS	volume,  specify
		   io1.   In  that  case  you can also supply the number of IOPS
		   that the volume supports in the iops argument.  For	example,
		   -m /dev/xvdf=snap-12345abc::false:io1:500.

     --monitor
	    Enable monitoring.

     -n N   Number of instances to launch.

     --number-secondary-ip, --secondary-private-ip-address-count=N
	    Number of secondary IP addresses to assign.

     -p, --iam-profile=NAME
	    IAM instance profile to associate with the launched instances.

     --placement-group=NAME
	    Name of the placement group.

     --private-ip-address=IP
	    Assign a specific private IP to the VPC instance.

     --ramdisk=ID
	    Select ramdisk ID.

     -s, --subnet=ID
	    Subnet to launch the instance into.

     --secondary-ip, --secondary-private-ip-address=IP
	    Assign the IP as a secondary private IP address.

     --shutdown, --instance-initiated-shutdown-behavior=stop|terminate
	    What to do on instance shutdown.

     -t, --type, --instance-type=TYPE
	    Instance type.

     --tenancy=STRING
	    Placement tenancy.

     -z, --zone, --availability-zone=ZONE
	    Set availablility zone.

OUTPUT
     On  success,  the	command outputs detailed description of each created in-
     stance in the same format as the eclat-lsinst(1) command

SEE ALSO
     eclat(1), eclat-terminate(1), eclat-lsiattr(1), eclat-lsinst(1), eclat-lsi-
     stat(1), eclat-reboot(1), eclat-setiattr(1), eclat-start(1), eclat-stop(1).

AUTHORS
     Sergey Poznyakoff

BUG REPORTS
     Report bugs to <bug-eclat@gnu.org.ua>.

COPYRIGHT
     Copyright (C) 2012-2018 Sergey Poznyakoff
     License GPLv3+: GNU GPL version 3 or later <http://gnu.org/li-
     censes/gpl.html>
     This is free software: you are free to change and redistribute  it.   There
     is NO WARRANTY, to the extent permitted by law.

ECLAT				November 17, 2018		 ECLAT-MKINST(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=eclat-mkinst&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help