{"id":18896390,"url":"https://github.com/openmainframeproject/snipl","last_synced_at":"2025-10-14T03:33:11.037Z","repository":{"id":105092436,"uuid":"232223903","full_name":"openmainframeproject/snipl","owner":"openmainframeproject","description":"Mirror of the Linux on System z snIPL 'simple network IPL' package.","archived":false,"fork":false,"pushed_at":"2020-01-07T02:15:44.000Z","size":135,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-31T17:56:18.060Z","etag":null,"topics":["linux","mainframe","mirror","s390x"],"latest_commit_sha":null,"homepage":"http://www.ibm.com/developerworks/linux/linux390/snipl.html","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openmainframeproject.png","metadata":{"files":{"readme":"README.snipl","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-07T02:14:35.000Z","updated_at":"2025-05-08T04:09:06.000Z","dependencies_parsed_at":null,"dependency_job_id":"cdf857df-fdd5-42d9-9b80-04222b39ebe8","html_url":"https://github.com/openmainframeproject/snipl","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/openmainframeproject/snipl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmainframeproject%2Fsnipl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmainframeproject%2Fsnipl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmainframeproject%2Fsnipl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmainframeproject%2Fsnipl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openmainframeproject","download_url":"https://codeload.github.com/openmainframeproject/snipl/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openmainframeproject%2Fsnipl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279017767,"owners_count":26086145,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-14T02:00:06.444Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["linux","mainframe","mirror","s390x"],"created_at":"2024-11-08T08:33:45.503Z","updated_at":"2025-10-14T03:33:11.000Z","avatar_url":"https://github.com/openmainframeproject.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"snipl (3.1.0)\r\n\r\nThe snipl (simple network IPL) package consists of three main parts, each of\r\nwhich serve as remote control of IBM Z hardware:\r\n   - snipl   : a command line program.\r\n   - lic_vps : a heartbeat-stonith plug-in that is called by stonith.\r\n   - sncap   : a command line program.\r\n\r\nsnipl can run in two modes: LPAR and z/VM mode.\r\n\r\nIn LPAR mode, snipl provides basic IBM Z support element (SE) functions\r\nfor LPARs. You can:\r\n - Activate, reset, or deactivate an LPAR.\r\n - Load (IPL) an LPAR from a disk device, for example, a DASD device or a\r\n   SCSI device.\r\n - Create a dump on a DASD or SCSI dump device.\r\n - Send commands to the operating system and retrieve operating system\r\n   messages.\r\n - Retrieve the status of an LPAR\r\nsnipl in LPAR mode uses the management application programming interfaces\r\n(APIs) of the SE or HMC that controls the LPAR. To use this API, snipl requires\r\nthe hwmcaapi library. See \"System z Application Programming Interfaces\",\r\nSB10-7030 for details about the hwmcaapi and about configuring LPARs\r\nfor remote access. You can obtain this publication and the hwmcaapi library\r\nfrom http://www.ibm.com/server/resourcelink, at IBM Systems \u003e IBM Z \u003e Resource\r\nLink \u003e Services \u003e IBM Z APIs \u003e Linux-390.\r\n\r\nIn z/VM mode, snipl provides basic z/VM systems management functions for\r\nz/VM guests. You can:\r\n - Log on, reset, or log off a z/VM guest virtual machine\r\n - Retrieve the status of a z/VM guest virtual machine\r\nsnipl in z/VM mode uses the systems management application programming\r\ninterfaces (APIs) of z/VM. How snipl communicates with the API on the z/VM\r\nsystem depends on your z/VM system version and on your system setup.\r\nAs of z/VM 5.3, you can access the API through a SMAPI request server.\r\nFor details about setting up your z/VM system for API access see\r\n\"z/VM Systems Management Application Programming\", SC24-6234.\r\nFor z/VM 4.4 to z/VM 5.4, you can access the API through the VSMSERVE service\r\nmachine. For details see about setting up your z/VM system see\r\n\"z/VM Systems Management Application Programming\", SC24-6122-02 or earlier.\r\nYou can obtain these publications from the z/VM website at\r\nhttp://www.vm.ibm.com\r\n\r\nFor the RPC-based VSMSERVE server clients contact the server remotely using the\r\nRPC primitives built on top of an eXternal Data Representation (XDR). The RPC\r\nprotocol specification provided is registered and can be found in the file\r\nDMSVSMA.X, which can be downloaded from z/VM and stored as dmsvsma.x\r\n(usually into /usr/share/dmsvsma/) on the Linux system where snipl is to\r\nbe built.\r\nNote that this functionality is deprecated as of snIPL 3.1.0, not compiled per\r\ndefault. To compile with DMSVSMA support, run 'make WITHVMOLD=1'. However, this\r\noption might be removed in a future snIPL release, and there is no guarantee\r\nthat the DMSVSMA support will stay functional.\r\n\r\nlic_vps (Linux Image Control - Virtual Power Switch) is a plug-in for STONITH\r\n(Shoot The Other Node In The Head) version 2.0.0 and later.\r\nSTONITH is part of the Linux heartbeat framework of the Linux\r\nHigh-Availability project (http://linux-ha.org). STONITH provides an extensible\r\ninterface for remotely powering down and restarting nodes in a cluster.\r\nhttp://linux-ha.org/wiki/STONITH gives a general description of the STONITH\r\ntechnique. The latest STONITH release is available at\r\nhttp://linux-ha.org/wiki/Downloads\r\n\r\nSee \"Device Drivers, Features, and Commands\", SC33-8411 about how to pass\r\nsnipl plug-in options to STONITH.\r\n\r\nsncap (Simple Network Capacity Management) is a command line tool which allows\r\nto control the dynamic CPU capacity of a CPC from the Linux environment. It\r\nprovides to the Linux users the following SE dynamic CPU capacity control\r\nfunctions:\r\n - Activate or deactivate an installed temporary capacity record.\r\n - Change a temporary capacity record activation level.\r\n - Query information about the CPCs controlled by an SE or HMC.\r\n - Query information about the temporary capacity records installed on the\r\n   CPC SE.\r\n - Query information about current temporary capacity record state.\r\nsncap uses the management application programming interfaces (APIs) of the SE \r\nor HMC that controls the CPC. To use this API, sncap requires the hwmcaapi \r\nlibrary. See \"System z Application Programming Interfaces\", SB10-7030 for \r\ndetails about the hwmcaapi and about configuring CPCs for remote access. You \r\ncan obtain this publication and the hwmcaapi library from \r\nhttp://www.ibm.com/server/resourcelink, at IBM Systems \u003e IBM Z \u003e Resource\r\nLink \u003e Services \u003e IBM Z APIs \u003e Linux-390.\r\n\r\nRelease History:\r\n================\r\n3.1.0\r\n    Changes:\r\n    - snipl: Introduce return code 100 to indicate SMAPI connection errors\r\n    - snipl: DMSVSMA deprecated\r\n    Bug Fixes:\r\n    - Fix error when compiling with openSSL 1.1\r\n\r\n3.0.0\r\n    Notes:\r\n    - Default behavior and command line parameters have changed. The default\r\n      is now to encrypt the connection. Also, the default password has been\r\n      removed. See changes below, consult the man page, and check that existing\r\n      scripts still work as expected.\r\n    Changes:\r\n    - Remove default password from snipl\r\n    - Enable SNMPv3 encrypted communication with HMC/SE\r\n    - Enable OpenSSL encrypted communication with SMAPI servers\r\n    Bug Fixes:\r\n    - Improve error and command line parameter handling\r\n    - Improve support for the x86_64 platform\r\n    - Add support for SCSI IPL with SSID 1, 2, and 3\r\n    - Various return-code fixes\r\n\r\n2.3.3\r\n    Changes:\r\n    - Add IPv6 support to snipl applications\r\n    Bug Fixes:\r\n    - fix vm6_wait_for_response return code is not returned on error\r\n    - improve Makefile to allow package builds on x86_64 platform\r\n    - fix segmentation fault when VM server is defined incompletely\r\n\r\n2.3.2\r\n    Changes:\r\n    - Allow to IPL from CCW devices in subchannel set not equal to zero\r\n    Bug Fixes:\r\n    - Endianness conversion for the SMAPI API fixed\r\n\r\n2.3.1\r\n    Changes:\r\n    - rename config.c into snconfig.c and libconfig.so into libsnconfig.so\r\n      to avoid name clash with other package\r\n    - Makefile adaptions for gcc-4.8\r\n    - adapt lic_vps.c to libglue-devel-1.0.12\r\n\r\n2.3.0\r\n    Changes:\r\n    - add the sncap program\r\n\r\n2.2.1\r\n    Bug Fixes:\r\n    - snipl --scsiload: correct checking of bps_scsiload\r\n    - snipl --getstatus: correct return code checking\r\n    - config file: correct server configs without userid\r\n\r\n2.2.0\r\n    Changes:\r\n    - provide access to SMAPI request server\r\n    - add option \"--getstatus\"\r\n\r\n2.1.9\r\n    Changes:\r\n    - add option \"--scsidump\"\r\n    - add option \"--stop\"\r\n\r\n2.1.8\r\n    Bug Fixes:\r\n    - snipl --dialog: avoid protocol errors\r\n\r\n2.1.7\r\n    Bug Fixes:\r\n    - snipl --deactivate: tolerate events other than 'command completion'\r\n\r\n2.1.6\r\n    Bug Fixes:\r\n    - snipl --dialog: add newlines to make sure all console messages show up\r\n    - adaptions to hwmcaapi-2.10.1.76\r\n\r\n2.1.5\r\n    Bug Fixes:\r\n    - stonith plugin: no error if fencing is invoked for a system being deactivated\r\n\r\n2.1.4\r\n    Bug Fixes:\r\n    - correct config file password propagation\r\n    - snipl --dialog: correct newline handling for sending commands\r\n    - stonith plugin: allowing different image servers in config file\r\n\r\n2.1.3\r\n    Changes:\r\n    -stonith plugin: upgrade to version 2\r\n    - add option \"--scsiload\"\r\n    - snipl --dialog: add option --msgfilename\r\n    - config file: add aliasing\r\n    - snipl LPAR: increase default --timeout from 10s to 60s\r\n\r\n2.1.2\r\n    Bug Fixes:\r\n    - snipl LPAR: enforce tcp_port 3161\r\n\r\nParts:\r\n======\r\nThe snipl package includes the following files:\r\n\r\nMakefile                snipl, lic_vps and sncap Makefile\r\nsnipl.h                 snipl source code (LPAR mode)\r\nvmsmapi.h               snipl source code (z/VM mode using the VSMSERVE service machine)\r\nvmsmapi6.h              snipl source code (z/VM mode using a SMAPI request server)\r\nstonith_config_xml.h    copy of generic xml definitions for stonith plugins *\r\nsnipl_stonith_plugin.h  copy of some stonith_plugin.h definitions *\r\nsnconfig.c              snipl configuration file handling stuff\r\nlic_vps.c               STONITH plugin\r\nprepare.c               type depending module load\r\nsnipl.c                 snipl source code\r\nsniplapi.c              snipl source code (LPAR mode)\r\nvmsmapi.c               snipl source code (z/VM mode using the VSMSERVE service machine)\r\nvmsmapi6.c              snipl source code (z/VM mode using a SMAPI request server)\r\nsnipl.8                 snipl man page\r\nLICENSE                 Common Public License Version 1.0\r\nREADME.snipl            this README\r\nsncap.c                 sncap source code\r\nsncap.h                 sncap source code (header file)\r\nsncapapi.c              sncap HWMCAAPI API interface\r\nsncapapi.h              sncap HWMCAAPI API interface (header file)\r\nsncapconf.c             sncap snipl configuration file interface\r\nsncapconf.h             sncap snipl configuration file interface (header file)\r\nsncapcpc.c              sncap CPC object handling \r\nsncapcpc.h              sncap CPC object handling (header file)\r\nsncapdsm.c              sncap temporary capacity record XML definition \r\n                        interface\r\nsncapdsm.h              sncap temporary capacity record XML definition \r\n                        interface (header file)\r\nsncapjob.c              sncap command line argument handling\r\nsncapjob.h              sncap command line argument handling (header file)\r\nsncaptcr.c              sncap temporary capacity record handling\r\nsncaptcr.h              sncap temporary capacity record handling (header file)\r\nsncaputil.c             sncap common utility functions\r\nsncaputil.h             sncap common utility functions (header file)\r\nsncap.8                 sncap man page\r\n\r\n\r\n(* this copy is needed because lic_vps must be built outside of the stonith\r\nbuild-tree)\r\n\r\nFor more information see the snipl, sncap and stonith man pages and\r\n\"Device Drivers, Features and Commands\", SC33-8411.\r\n\r\nRequirements:\r\n=============\r\n- To compile and run snipl for LPARs running Linux on IBM Z,\r\n  the hwmcaapi library is required.\r\n  Usually libhwmcaapi.so is expected in /usr/lib/ or /usr/lib64/.\r\n- To communicate with the SE or HMC, the snipl programs require udp-port 161\r\n  and tcp-port 3161. These ports must not be blocked by a firewall.\r\n- To compile and run snipl for z/VM guest virtual machines, managed with the\r\n  SMAPI request server, the request server environment has to be installed and\r\n  configured by a z/VM administrator.\r\n- To compile and run snipl for z/VM guests, managed with an RPC-based VSMSERVE\r\n  service machine, the RPC protocol specification DMSVSMA.X has to be downloaded\r\n  to the Linux system running snipl (usually into /usr/share/dmsvsma/).\r\n  The VSMSERVE service machine must be installed and configured (including its\r\n  TCP/IP- and RACF-definitions). Images controlled by snipl have to be defined\r\n  in the authlist of VSMSERVE.\r\n  Furthermore, snIPL has to be compiled with WITHVMOLD=1 (see respective\r\n  section above), as the DMSVSMA functionality in snipl is considered\r\n  deprecated.\r\n- To compile and use the STONITH plug-in lic_vps, package Cluster Glue\r\n  has to be downloaded from http://linux-ha.org/wiki/Downloads and installed.\r\n  STONITH requires the installation of the heartbeat packages heartbeat-pils and\r\n  heartbeat-stonith created from the Cluster Glue tarball.\r\n  When invoking stonith, make sure:\r\n    - libstonith.so, libpils.so, and libglib-2.0 are available within your\r\n      active library path.\r\n    - lic_vps.a, lic_vps.la, and lic_vps.so are available in your stonith\r\n      plug-in directory\r\n      (usually /usr/lib64/stonith/plugins/stonith2/ )\r\n- To compile and run sncap the hwmcaapi library is required. sncap has been\r\n  tested with the SE and HMC hwmcaapi library 2.10.2 in System z10, and z196.\r\n- Using of sncap requires the SE or HMC software version 2.10.0 or later.\r\n\r\nRestrictions:\r\n- snipl package programs do not recover connection failures or management API \r\n  error messages. In case of, for example, a timeout, snipl package programs \r\n  display the error code (see \"System z Application Programming Interfaces\", \r\n  SB10-7030) along with a short message. Verify that the SE or HMC is reachable\r\n  via the network and that the SE or HMC is configured properly.\r\n- snipl in LPAR mode acknowledges when a load command has been accepted\r\n  by the management API on the SE. However you must check, whether\r\n  the load command has completed successfully. For example, snipl cannot\r\n  determine if an incorrect load address has been used as input.\r\n- sncap command processes cannot be executed in parallel for the same CPC for\r\n  temporary capacity record activation or deactivation. Also, sncap process \r\n  started for a temporary capacity record activation or deactivation cannot\r\n  run in parallel with a snipl process being executed for the same CPC.\r\n\r\nCopyright IBM Corp. 2001, 2016\r\n\r\nTHE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THE ENCLOSED COMMON\r\nPUBLIC LICENSE (\"AGREEMENT\"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE\r\nPROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmainframeproject%2Fsnipl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenmainframeproject%2Fsnipl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenmainframeproject%2Fsnipl/lists"}