iocage 1.10 documentation
modules
|
index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
A
Activate iocage
activate() (iocage_lib.iocage.IOCage method)
Advance Usage
Apply Limits
Auto-Boot
Automatic Package Installation
B
backup_iocage_jail_conf() (iocage_lib.ioc_json.IOCConfiguration method)
Basejails
Basic Jail Creation
Basic Usage
Best Practices
boolean_prop_exists() (in module iocage_lib.ioc_common)
Boot Priority
C
callback() (in module iocage_lib.ioc_common)
Check Limits
check_aliases() (iocage_lib.ioc_start.IOCStart method)
check_config() (iocage_lib.ioc_json.IOCConfiguration method)
check_default_config() (iocage_lib.ioc_json.IOCConfiguration method)
check_jail_config() (iocage_lib.ioc_json.IOCConfiguration method)
check_release_newer() (in module iocage_lib.ioc_common)
check_truthy() (in module iocage_lib.ioc_common)
checkoutput() (in module iocage_lib.ioc_common)
child_test() (in module iocage_cli.destroy)
chroot() (iocage_lib.iocage.IOCage method)
clean() (iocage_lib.iocage.IOCage method)
clean_all() (iocage_lib.ioc_clean.IOCClean method)
clean_debug() (iocage_lib.ioc_clean.IOCClean method)
clean_images() (iocage_lib.ioc_clean.IOCClean method)
clean_jails() (iocage_lib.ioc_clean.IOCClean method)
clean_releases() (iocage_lib.ioc_clean.IOCClean method)
clean_templates() (iocage_lib.ioc_clean.IOCClean method)
Clone Jails
Clones
CommandFailed
CommandNeedsRoot
Configure a Jail
Configure Network Interfaces
Configure Shared IP jail
Configure VNET Jail
construct_truthy() (in module iocage_lib.ioc_common)
consume_and_log() (in module iocage_lib.ioc_common)
copytree() (in module iocage_lib.ioc_common)
Create clones
Create Debian Jail
create() (iocage_lib.iocage.IOCage method)
create_config() (iocage_lib.ioc_create.IOCCreate method)
create_install_packages() (iocage_lib.ioc_create.IOCCreate method)
create_jail() (iocage_lib.ioc_create.IOCCreate method)
create_rc() (iocage_lib.ioc_create.IOCCreate method)
create_thickjail() (iocage_lib.ioc_create.IOCCreate method)
D
deactivate() (iocage_lib.iocage.IOCage method)
debug() (iocage_lib.iocage.IOCage method)
default_only_props (iocage_lib.ioc_json.IOCJson attribute)
DEFAULT_PROPS (iocage_lib.ioc_plugin.IOCPlugin attribute)
Depends Property
Destroy a Jail
destroy_jail() (iocage_lib.ioc_destroy.IOCDestroy method)
(iocage_lib.iocage.IOCage method)
destroy_release() (iocage_lib.iocage.IOCage method)
df() (iocage_lib.iocage.IOCage method)
E
emit() (iocage_cli.InfoHandler method)
Empty Jails
ExceptionWithMsg
exec() (iocage_lib.iocage.IOCage method)
exec_all() (iocage_lib.iocage.IOCage method)
exec_jail() (iocage_lib.ioc_exec.IOCExec method)
Exists
expand_abi_with_specified_release() (iocage_lib.ioc_plugin.IOCPlugin static method)
export() (iocage_lib.iocage.IOCage method)
export_jail() (iocage_lib.ioc_image.IOCImage method)
Ezjail Migration
F
FAQ
fastentrypoints
module
Fetch a release
fetch() (iocage_lib.iocage.IOCage method)
fetch_download() (iocage_lib.ioc_fetch.IOCFetch method)
fetch_extract() (iocage_lib.ioc_fetch.IOCFetch method)
fetch_http_release() (iocage_lib.ioc_fetch.IOCFetch method)
fetch_plugin() (iocage_lib.ioc_plugin.IOCPlugin method)
fetch_plugin_index() (iocage_lib.ioc_plugin.IOCPlugin method)
fetch_plugin_packagesites() (iocage_lib.ioc_plugin.IOCPlugin static method)
fetch_plugin_versions() (iocage_lib.ioc_plugin.IOCPlugin method)
fetch_plugin_versions_from_plugin_index() (iocage_lib.ioc_plugin.IOCPlugin static method)
fetch_release() (iocage_lib.ioc_fetch.IOCFetch method)
fetch_update() (iocage_lib.ioc_fetch.IOCFetch method)
find_bridge_mtu() (iocage_lib.ioc_start.IOCStart method)
fix_properties() (iocage_lib.ioc_json.IOCConfiguration method)
flight_checks() (iocage_lib.ioc_exec.IOCExec method)
fs_file (iocage_lib.ioc_fstab.Fstab attribute)
fs_freq (iocage_lib.ioc_fstab.Fstab attribute)
fs_mntops (iocage_lib.ioc_fstab.Fstab attribute)
fs_passno (iocage_lib.ioc_fstab.Fstab attribute)
fs_spec (iocage_lib.ioc_fstab.Fstab attribute)
fs_type (iocage_lib.ioc_fstab.Fstab attribute)
fs_vfstype (iocage_lib.ioc_fstab.Fstab attribute)
Fstab (class in iocage_lib.ioc_fstab)
fstab() (iocage_lib.iocage.IOCage method)
fstab_list() (iocage_lib.ioc_fstab.IOCFstab method)
G
gen_nat_ip() (in module iocage_lib.ioc_common)
gen_unused_lo_ip() (in module iocage_lib.ioc_common)
generate_devfs_ruleset() (in module iocage_lib.ioc_common)
Get Property
get() (iocage_lib.iocage.IOCage method)
get_active_jails() (in module iocage_lib.ioc_common)
get_args() (in module fastentrypoints)
get_bridge_members() (iocage_lib.ioc_start.IOCStart method)
get_command() (iocage_cli.IOCageCLI method)
get_default_gateway() (iocage_lib.ioc_start.IOCStart method)
get_default_interface() (iocage_lib.ioc_start.IOCStart method)
get_full_config() (iocage_lib.ioc_json.IOCJson method)
get_host_gateways() (in module iocage_lib.ioc_common)
get_host_release() (in module iocage_lib.ioc_common)
get_iocroot() (iocage_lib.iocage.PoolAndDataset method)
get_jail_freebsd_version() (in module iocage_lib.ioc_common)
get_jails_with_config() (in module iocage_lib.ioc_common)
get_mac_prefix() (iocage_lib.ioc_json.IOCConfiguration static method)
get_name_sortkey() (in module iocage_lib.ioc_common)
get_natural_sortkey() (in module iocage_lib.ioc_common)
get_nested_key() (in module iocage_lib.ioc_common)
get_pool() (iocage_lib.iocage.PoolAndDataset method)
get_pool_and_iocroot() (iocage_lib.ioc_json.IOCConfiguration method)
get_size_sortkey() (in module iocage_lib.ioc_common)
get_used_ips() (in module iocage_lib.ioc_common)
get_version() (iocage_lib.ioc_json.IOCConfiguration static method)
I
ignore_exceptions() (in module iocage_lib.ioc_exceptions)
import_() (iocage_lib.iocage.IOCage method)
import_jail() (iocage_lib.ioc_image.IOCImage method)
InfoHandler (class in iocage_cli)
Install iocage
InteractiveExec (class in iocage_lib.ioc_exec)
ioc_sort() (in module iocage_lib.ioc_common)
IOCage (class in iocage_lib.iocage)
iocage_cli
module
iocage_cli.activate
module
iocage_cli.chroot
module
iocage_cli.clean
module
iocage_cli.clone
module
iocage_cli.console
module
iocage_cli.create
module
iocage_cli.debug
module
iocage_cli.destroy
module
iocage_cli.df
module
iocage_cli.exec
module
iocage_cli.export
module
iocage_cli.fetch
module
iocage_cli.fstab
module
iocage_cli.get
module
iocage_cli.import
module
iocage_cli.list
module
iocage_cli.migrate
module
iocage_cli.pkg
module
iocage_cli.rename
module
iocage_cli.restart
module
iocage_cli.rollback
module
iocage_cli.set
module
iocage_cli.snaplist
module
iocage_cli.snapremove
module
iocage_cli.snapshot
module
iocage_cli.start
module
iocage_cli.stop
module
iocage_cli.update
module
iocage_cli.upgrade
module
iocage_lib
module
iocage_lib.ioc_check
module
iocage_lib.ioc_clean
module
iocage_lib.ioc_common
module
iocage_lib.ioc_create
module
iocage_lib.ioc_debug
module
iocage_lib.ioc_destroy
module
iocage_lib.ioc_exceptions
module
iocage_lib.ioc_exec
module
iocage_lib.ioc_fetch
module
iocage_lib.ioc_fstab
module
iocage_lib.ioc_image
module
iocage_lib.ioc_json
module
iocage_lib.ioc_list
module
iocage_lib.ioc_plugin
module
iocage_lib.ioc_start
module
iocage_lib.ioc_stop
module
iocage_lib.ioc_upgrade
module
iocage_lib.iocage
module
IOCageCLI (class in iocage_cli)
IOCCheck (class in iocage_lib.ioc_check)
IOCClean (class in iocage_lib.ioc_clean)
IOCConfiguration (class in iocage_lib.ioc_json)
IOCCpuset (class in iocage_lib.ioc_json)
IOCCreate (class in iocage_lib.ioc_create)
IOCDebug (class in iocage_lib.ioc_debug)
IOCDestroy (class in iocage_lib.ioc_destroy)
IOCExec (class in iocage_lib.ioc_exec)
IOCFetch (class in iocage_lib.ioc_fetch)
IOCFstab (class in iocage_lib.ioc_fstab)
IOCImage (class in iocage_lib.ioc_image)
IOCJson (class in iocage_lib.ioc_json)
IOCList (class in iocage_lib.ioc_list)
IOCLogger (class in iocage_cli)
IOCPlugin (class in iocage_lib.ioc_plugin)
IOCRCTL (class in iocage_lib.ioc_json)
IOCStart (class in iocage_lib.ioc_start)
IOCStop (class in iocage_lib.ioc_stop)
IOCUpgrade (class in iocage_lib.ioc_upgrade)
IPv6 Host Bind Failure
J
Jail Restart
Jail Start
Jail start stop restart
Jail Stop
Jail Types
JailCorruptConfiguration
JailMisconfigured
JailMissingConfiguration
JailRunning
JailRuntimeConfiguration (class in iocage_lib.ioc_json)
json_check_prop() (iocage_lib.ioc_json.IOCJson method)
json_convert_from_ucl() (iocage_lib.ioc_json.IOCJson method)
json_convert_from_zfs() (iocage_lib.ioc_json.IOCJson method)
json_get_value() (iocage_lib.ioc_json.IOCJson method)
json_load() (iocage_lib.ioc_json.IOCJson method)
json_migrate_uuid_to_tag() (iocage_lib.ioc_json.IOCJson method)
json_plugin_get_value() (iocage_lib.ioc_json.IOCJson method)
json_plugin_load() (iocage_lib.ioc_json.IOCJson method)
json_plugin_set_value() (iocage_lib.ioc_json.IOCJson method)
json_set_value() (iocage_lib.ioc_json.IOCJson method)
json_write() (iocage_lib.ioc_json.IOCConfiguration method)
K
Known Issues
,
[1]
,
[2]
,
[3]
,
[4]
L
Limit Cores or Threads
Limit CPU Usage by Percentage
Limit DRAM Usage
List Applied Rules
list() (iocage_lib.iocage.IOCage method)
list_all() (iocage_lib.ioc_list.IOCList method)
list_all_quick() (iocage_lib.ioc_list.IOCList method)
list_bases() (iocage_lib.ioc_list.IOCList method)
list_commands() (iocage_cli.IOCageCLI method)
list_datasets() (iocage_lib.ioc_list.IOCList method)
list_get_jid() (iocage_lib.ioc_list.IOCList class method)
Listing Jails
logit() (in module iocage_lib.ioc_common)
lowercase_set() (in module iocage_lib.ioc_common)
M
main() (in module fastentrypoints)
match_to_dir() (in module iocage_lib.ioc_common)
module
fastentrypoints
iocage_cli
iocage_cli.activate
iocage_cli.chroot
iocage_cli.clean
iocage_cli.clone
iocage_cli.console
iocage_cli.create
iocage_cli.debug
iocage_cli.destroy
iocage_cli.df
iocage_cli.exec
iocage_cli.export
iocage_cli.fetch
iocage_cli.fstab
iocage_cli.get
iocage_cli.import
iocage_cli.list
iocage_cli.migrate
iocage_cli.pkg
iocage_cli.rename
iocage_cli.restart
iocage_cli.rollback
iocage_cli.set
iocage_cli.snaplist
iocage_cli.snapremove
iocage_cli.snapshot
iocage_cli.start
iocage_cli.stop
iocage_cli.update
iocage_cli.upgrade
iocage_lib
iocage_lib.ioc_check
iocage_lib.ioc_clean
iocage_lib.ioc_common
iocage_lib.ioc_create
iocage_lib.ioc_debug
iocage_lib.ioc_destroy
iocage_lib.ioc_exceptions
iocage_lib.ioc_exec
iocage_lib.ioc_fetch
iocage_lib.ioc_fstab
iocage_lib.ioc_image
iocage_lib.ioc_json
iocage_lib.ioc_list
iocage_lib.ioc_plugin
iocage_lib.ioc_start
iocage_lib.ioc_stop
iocage_lib.ioc_upgrade
iocage_lib.iocage
Mount Path Limit
N
Networking
normalize_data() (iocage_lib.ioc_json.JailRuntimeConfiguration method)
O
open_atomic() (in module iocage_lib.ioc_common)
P
parse_latest_release() (in module iocage_lib.ioc_common)
parse_package_name() (in module iocage_lib.ioc_common)
path (iocage_lib.ioc_json.JailRuntimeConfiguration property)
PLUGIN_VERSION (iocage_lib.ioc_plugin.IOCPlugin attribute)
Plugins
PoolAndDataset (class in iocage_lib.iocage)
PoolNotActivated
print_version() (in module iocage_cli)
Promote a Clone
pull_clone_git_repo() (iocage_lib.ioc_plugin.IOCPlugin method)
R
raise_sort_error() (in module iocage_lib.ioc_common)
rctl_rules_exist() (iocage_lib.ioc_json.IOCRCTL method)
remove() (iocage_lib.ioc_json.JailRuntimeConfiguration method)
remove_rctl_rules() (iocage_lib.ioc_json.IOCRCTL method)
Rename Jail
rename() (iocage_lib.iocage.IOCage method)
reset_cache() (iocage_lib.iocage.IOCage static method)
Resource Limits
restart() (iocage_lib.iocage.IOCage method)
retrieve_admin_portals() (in module iocage_lib.ioc_common)
retrieve_cpu_sets() (iocage_lib.ioc_json.IOCCpuset static method)
retrieve_default_props() (iocage_lib.ioc_json.IOCConfiguration static method)
retrieve_ip4_for_jail() (in module iocage_lib.ioc_common)
retrieve_plugin_index_data() (iocage_lib.ioc_plugin.IOCPlugin static method)
retrieve_plugin_json() (iocage_lib.ioc_plugin.IOCPlugin method)
rollback() (iocage_lib.iocage.IOCage method)
run_debug() (iocage_lib.ioc_debug.IOCDebug method)
run_host_debug() (iocage_lib.ioc_debug.IOCDebug method)
run_jail_debug() (iocage_lib.ioc_debug.IOCDebug method)
runscript() (in module iocage_lib.ioc_common)
S
Set Property
set() (iocage_lib.ioc_json.JailRuntimeConfiguration method)
(iocage_lib.iocage.IOCage method)
set_cpuset() (iocage_lib.ioc_json.IOCCpuset method)
set_interactive() (in module iocage_lib.ioc_common)
set_rcconf() (in module iocage_lib.ioc_common)
set_rctl_rules() (iocage_lib.ioc_json.IOCRCTL method)
setConsoleLogLevel() (iocage_cli.IOCLogger method)
Setting environment variables
Shared IP
SilentExec (class in iocage_lib.ioc_exec)
snap_list() (iocage_lib.iocage.IOCage method)
snap_list_all() (iocage_lib.iocage.IOCage method)
snap_remove() (iocage_lib.iocage.IOCage method)
snap_remove_all() (iocage_lib.iocage.IOCage method)
Snapshot Management
snapshot() (iocage_lib.iocage.IOCage method)
snapshot_all() (iocage_lib.iocage.IOCage method)
sort_ava() (in module iocage_lib.ioc_common)
sort_boot() (in module iocage_lib.ioc_common)
sort_created() (in module iocage_lib.ioc_common)
sort_crt() (in module iocage_lib.ioc_common)
sort_ip() (in module iocage_lib.ioc_common)
sort_ip6() (in module iocage_lib.ioc_common)
sort_jid() (in module iocage_lib.ioc_common)
sort_key() (in module iocage_lib.ioc_common)
sort_name() (in module iocage_lib.ioc_common)
sort_qta() (in module iocage_lib.ioc_common)
sort_release() (in module iocage_lib.ioc_common)
sort_res() (in module iocage_lib.ioc_common)
sort_state() (in module iocage_lib.ioc_common)
sort_template() (in module iocage_lib.ioc_common)
sort_type() (in module iocage_lib.ioc_common)
sort_use() (in module iocage_lib.ioc_common)
start() (iocage_lib.iocage.IOCage method)
start_copy_localtime() (iocage_lib.ioc_start.IOCStart method)
start_generate_resolv() (iocage_lib.ioc_start.IOCStart method)
start_network() (iocage_lib.ioc_start.IOCStart method)
start_network_interface_vnet() (iocage_lib.ioc_start.IOCStart method)
start_network_vnet_addr() (iocage_lib.ioc_start.IOCStart method)
start_network_vnet_iface() (iocage_lib.ioc_start.IOCStart method)
start_rc() (iocage_lib.ioc_plugin.IOCPlugin method)
stop() (iocage_lib.iocage.IOCage method)
stop_rc() (iocage_lib.ioc_plugin.IOCPlugin method)
sync_changes() (iocage_lib.ioc_json.JailRuntimeConfiguration method)
T
tempfile() (in module iocage_lib.ioc_common)
Template Jails
Thickjail
Tips for configuring VNET
tmp_dataset_checks() (in module iocage_lib.ioc_common)
truthy_inverse_values() (in module iocage_lib.ioc_common)
truthy_props (iocage_lib.ioc_json.IOCJson attribute)
truthy_values() (in module iocage_lib.ioc_common)
try_convert() (in module iocage_lib.ioc_common)
Turn on Resource Limits
types (iocage_lib.ioc_json.IOCRCTL attribute)
U
untar_release_filter() (in module iocage_lib.ioc_fetch)
update() (iocage_lib.ioc_plugin.IOCPlugin method)
(iocage_lib.iocage.IOCage method)
update_all() (iocage_lib.iocage.IOCage method)
update_progress() (iocage_lib.ioc_fetch.IOCFetch method)
Updating Jails
Upgrade Jails
upgrade() (iocage_lib.ioc_plugin.IOCPlugin method)
(iocage_lib.iocage.IOCage method)
upgrade_all() (iocage_lib.iocage.IOCage method)
upgrade_basejail() (iocage_lib.ioc_upgrade.IOCUpgrade method)
upgrade_jail() (iocage_lib.ioc_upgrade.IOCUpgrade method)
Using Shared IP
Using Templates
V
validate_count() (in module iocage_cli.clone)
(in module iocage_cli.create)
(in module iocage_cli.fetch)
validate_cpuset_prop() (iocage_lib.ioc_json.IOCCpuset static method)
validate_mac_prefix() (iocage_lib.ioc_json.IOCConfiguration static method)
validate_plugin_manifest() (in module iocage_lib.ioc_common)
validate_rctl_props() (iocage_lib.ioc_json.IOCRCTL static method)
validate_rctl_tunable() (iocage_lib.ioc_json.IOCRCTL static method)
ValidationFailed
ValueNotFound
VIMAGE_VNET
VNET and ALTQ
VNET tips
VNET/VIMAGE
Table of Contents
Install iocage
Basic Usage
Plugins
Networking
Jail Types
Best Practices
Advanced Usage
Using Templates
Create a Debian Buster Jail (native Linux)
Known Issues
FAQ
Search